Reference Guide

Vertex® Indirect Tax O Series® 9.0

Configuration Parameters

September 2022
Copyright and legal notices
Copyright © 2022 Vertex, Inc. All rights reserved.
This documentation may not be reproduced, displayed, distributed, modified, posted,
republished, or transmitted in any form or by any means, without the prior written consent of
Vertex, Inc. or its affiliates (collectively, “Vertex”), except as otherwise specified in a valid,
current Vertex license agreement or allowed by law.
Disclaimers
The information contained in this documentation is designed to help users in regard to the
subject matter covered. Some of it may be based upon interpretations of federal, state, foreign
and other tax laws and regulations. Each entity is responsible for making its own determination
of how such laws and regulations apply to its own circumstances and for evaluating the
capabilities of, and all data and results generated by, any product that is described in this
documentation. Vertex is not engaged in providing legal, tax or accounting advice or services
and the information contained in this documentation or in any product cannot replace the
advice of competent legal counsel. Further, the information in this documentation is subject to
change without notice and is not warranted to be error-free. If you find any errors, please
report them to us in writing.
Trademarks and Service Marks
The trademarks, logos and service marks ("marks") displayed in this documentation are the
property of Vertex or other third parties. Users are not permitted to use these marks without
the prior written consent of Vertex or the third party that may own the mark.
Third Party Products
Copies of the licenses for some third-party products included with a Vertex product may be
found in or with the installation materials for that product.
Contents

What's New in This Guide................................................................................................................... 12

What's new in this guide for 9.0 SR11 (September 2022) .......................................................................... 12
What's new in this guide for 9.0 SR10 (July 2022) ...................................................................................... 12
What's new in this guide for 9.0 SR9 (March 2022) .................................................................................... 13
What's new in this guide for 9.0 SR8 (December 2021).............................................................................. 13
What's new in this guide for November 2021............................................................................................. 14
What's new in this guide for 9.0 SR5 (July 2021) ........................................................................................ 15
What's new in this guide for 9.0 SR4 (April 2021) ....................................................................................... 16
What's new in this guide for 9.0 SR3 MP2 (January 2021) ......................................................................... 16
What's new in this guide for 9.0 SR3 (October 2020) ................................................................................. 17
What's new in this guide for 9.0 SR2 MP2 (September 2020) .................................................................... 18
What's new in this guide for 9.0 SR2 (July 2020) ........................................................................................ 18
What's new in this guide for 9.0 SR 1 (March 2020) ................................................................................... 19
What's new in this guide for 9.0 (August, December 2019) ....................................................................... 20

Preface ............................................................................................................................................... 22
About Vertex and our services .................................................................................................................... 22
About Vertex O Series ................................................................................................................................. 24
Finding information about Vertex Indirect Tax O Series ............................................................................. 26
About this guide .......................................................................................................................................... 30

Chapter 1. Configuration Overview .................................................................................................... 31

The three ways to set configuration information ....................................................................................... 31
What are Preferences? ................................................................................................................................ 32
What are Settings? ...................................................................................................................................... 32
The O Series configuration file and O Series On-Demand .......................................................................... 33
Changing the name of the Vertex configuration file (VertexConfigFile) ......................................................................................... 33
Guidelines for configuration security .......................................................................................................... 33
Back up the [Link] file ............................................................................................................................................................... 33
Limit the number of users who can change configuration data ...................................................................................................... 34
Types of parameters you can change.......................................................................................................... 35
Managing the O Series configuration file .................................................................................................... 36
Editing the [Link] file ................................................................................................................................................................ 37
Setting transactions in the Transaction Tester to post to the Tax Journal ...................................................................................... 38
Application Log file .......................................................................................................................................................................... 39
Define the system logging threshold ([Link]) ................................................................................................... 43

Chapter 2. Setting the Level of System Information in Log Files .......................................................... 44

Setting the level of system error messages ................................................................................................ 44
Providing additional details about XML schema issues in the log file
([Link]) ............................................................................................ 45
Transaction Dump ....................................................................................................................................... 45
Defining logging levels for Java exceptions ([Link]) .................................................... 46

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide

[Link] .............................................................................................................................................. 46
How changing the default directory for the log files relates to the [Link] file .......................................................................... 46
How to override transaction-level details in the log file ............................................................................. 47
Echo log messages to the console ([Link]) ......................................................................... 47
Set the amount of disk space for log files ([Link]) ............................................................ 48
Set the number of hours a log is kept open ([Link]) .............................................................. 48
Set the maximum size of a single log file ([Link]) .................................................................. 48
Log the partition ID ([Link]) ............................................................................................ 49
Log Level for Invalid Address Exceptions .................................................................................................... 50
Map metadata to a display value ([Link])................................................................................. 51

Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance .......................................... 52
Database connection parameters ............................................................................................................... 52
O Series database connections ([Link].logical_database_name) .............................................................................. 53
Alias connections............................................................................................................................................................................. 55
Define the JDBC driver ([Link].x)......................................................................................................................... 56
Setting the managed database connection pool cleanup service interval ([Link]) ....... 57
Setting the managed database connection pool maximum idle time ([Link]).............................. 58
Setting the number of managed database connection pool maximum idle connections
([Link]) ...................................................................................................................... 59
[Link] ........................................................................................................................ 60
O Series Security parameters ...................................................................................................................... 60
Enable trusted login ([Link]) ................................................................................................................... 61
Set the password to be alphanumeric ([Link]) .............................................................. 61
Set the password to require special characters ([Link]) ......................................... 61
Set the number of failed login attempts permitted ([Link]) ............................................... 62
Handling failed login attempts ([Link]) ................................................................................................................ 62
IP address lockout period ([Link]) ................................................................................................................ 63
Password reset email subject ([Link]) ............................................................................................... 63
Password reset email text ([Link]) .......................................................................................................... 63
Permit reuse of passwords ([Link]) ......................................................................... 64
Set password minimum length ([Link]) ............................................................................................. 64
Set the user name minimum length ([Link]) ..................................................................................... 65
Encrypted Proxy Password .............................................................................................................................................................. 65
Encrypted Proxy User ...................................................................................................................................................................... 66
Password Expiration (Days) ............................................................................................................................................................. 66
Max User Inactivity (Days)............................................................................................................................................................... 66
Proxy Host ....................................................................................................................................................................................... 67
Proxy Password ............................................................................................................................................................................... 67
Proxy Port ........................................................................................................................................................................................ 68
Proxy User ....................................................................................................................................................................................... 68
Federated security parameters ................................................................................................................... 69
Security configuration ..................................................................................................................................................................... 69
OAuth 2.0 integration properties .................................................................................................................................................... 72
SAML 2.0 integration properties ..................................................................................................................................................... 77
Data Management parameters ................................................................................................................... 86
Define the root directory ([Link]).................................................................................................... 86
Set how long before old update records are purged ([Link]) .............................................................. 86
Disabling a Cache Refresh ([Link]) .............................................................................................. 87
Override the default location for your files ([Link]) ...................................................................... 87
Tax Journal Export email ([Link]) .................................................................................... 88

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide

Retail Tax Extract email ([Link]) ................................................................................ 88

DPP Transactions Exempt ................................................................................................................................................................ 89
Specify the subject line in email sent when Tax Journal Export fails ([Link])..... 89
Specify the subject line in email sent when Retail Tax Extract fails ([Link])..................... 90
Data Management base directory ([Link]) ................................................................................................................. 90
Specify the text of email sent when Tax Journal Export fails ([Link]) .............. 91
Specify the text of email sent when Retail Tax Extract fails ([Link]) .............................. 91
Base directory for data movement manifest files ([Link]) ........................................................................... 92
Define the number of rows purged ([Link]) ............................................................................................................ 92
Customer Limit ................................................................................................................................................................................ 92
Exemption Certificate Limit ............................................................................................................................................................. 93
Taxability Driver Limit...................................................................................................................................................................... 94
Taxability Mapping Limit ................................................................................................................................................................. 95
Taxpayer Limit ................................................................................................................................................................................. 95
Vendor Limit .................................................................................................................................................................................... 96
Web Service Parameters ............................................................................................................................. 96
Define the Vertex schema locations ([Link]) ................................................................................ 97
Enable Schema Validation ............................................................................................................................................................... 97
Return Detailed Tax Calculation Timings ......................................................................................................................................... 98
Installed web applications ............................................................................................................................................................... 98
Simple Mail Transfer Protocol (SMTP) ........................................................................................................ 99
SMTP Security Requirements ([Link]) ................................................................. 99
SMTP Host Name ([Link]) ......................................................................................... 100
SMTP password ([Link]) ............................................................................................ 100
SMTP user name ([Link]) .......................................................................................... 101

Chapter 4. Calculation Engine Parameters ........................................................................................ 102

How the Calculation Engine handles multi-currency calculations ............................................................ 104
How standard invoice verification processing works ................................................................................ 105
What does the Calculation Engine evaluate during invoice verification processing? ................................................................... 105
How the Calculation Engine processes vendor registration information ...................................................................................... 106
How to override Calculation Engine processing when Charged Tax amount is zero ..................................................................... 106
Assume Vendor Registration for Invoice Verification.................................................................................................................... 106
Taxability Precedence - Sales .................................................................................................................... 108
Requirements for using taxability precedence settings ................................................................................................................ 109
Sales - Commodity Code Processing Order ................................................................................................................................... 109
Sales - Customer Class Processing Order....................................................................................................................................... 110
Sales - Customer Processing Order ............................................................................................................................................... 110
Sales - Flexible Fields Processing Order ......................................................................................................................................... 110
Sales - Material Origin Processing Order ....................................................................................................................................... 111
Sales - Product Class Processing Order.......................................................................................................................................... 111
Sales - Product Processing Order .................................................................................................................................................. 111
Sales - Taxpayer Processing Order ................................................................................................................................................ 112
Sales - Usage Class Processing Order ............................................................................................................................................ 112
Sales - Usage Processing Order ..................................................................................................................................................... 112
Taxability Precedence - Procurement ....................................................................................................... 112
Procurement - Commodity Code Processing Order ...................................................................................................................... 113
Procurement - Cost Center Processing Order ............................................................................................................................... 113
Procurement - Department Code Processing Order ..................................................................................................................... 113
Procurement - Flexible Fields Processing Order ............................................................................................................................ 114
Procurement - General Ledger Account Processing Order............................................................................................................ 114
Procurement - Material Code Processing Order ........................................................................................................................... 114
Procurement - Material Origin Processing Order .......................................................................................................................... 115

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide

Procurement - Project Number Processing Order......................................................................................................................... 115

Procurement - Purchase Class Processing Order........................................................................................................................... 115
Procurement - Purchase Processing Order ................................................................................................................................... 116
Procurement - Taxpayer Processing Order ................................................................................................................................... 116
Procurement - Usage Class Processing Order ............................................................................................................................... 116
Procurement - Usage Processing Order ........................................................................................................................................ 117
Procurement - Vendor Class Processing Order ............................................................................................................................. 117
Procurement - Vendor Processing Order ...................................................................................................................................... 118
Procurement - Vendor SKU Processing Order ............................................................................................................................... 118
Adjust the penny difference on tax ........................................................................................................... 119
Accrue Assisted Line Items as Independent Line Items ............................................................................ 121
Allow Fair Market Value and Extended Price to have different signs ....................................................... 121
Calculate Lowest Total Tax ........................................................................................................................ 122
Disable Gross Receipts Tax Imposition Type Inclusion Rules in Alabama ................................................. 123
Hawaii jurisdiction level rounding ([Link].hawaii_jurisdiction_level_rounding) .................... 124
Include Basis Inclusions in Nontaxable Basis............................................................................................. 124
Return No Tax elements for primary impositions ..................................................................................... 125
Return No Tax elements with Output Notices or Invoice Text Codes....................................................... 126
Return the Material Origin Code ............................................................................................................... 127
Rounding - Group By Tax Rate................................................................................................................... 127
Include Response Time.............................................................................................................................. 128
Skip Transaction Row ................................................................................................................................ 128
Allow Empty Unit of Measure ................................................................................................................... 129
Do Not Show NoTax Results ...................................................................................................................... 129
Max Trials .................................................................................................................................................. 130
Best practices for using the Max Trials setting .............................................................................................................................. 130
A delete request deletes all transactions with the same transaction ID - OS ........................................... 131
Force Distribute Tax on Failure - Supplies ................................................................................................. 132
Force Distribute Tax on Failure - Procurement ......................................................................................... 133
Transaction Dump ..................................................................................................................................... 134
Single Jurisdiction VAT Tax Inclusive Optimized Path ............................................................................... 134
Group Positive and Negative Line Items Together .................................................................................... 135
Include Services in Apportionment ........................................................................................................... 136
Include Charged Tax in Allocated Line Item .............................................................................................. 136
Exclude Tax Areas With Unregistered Jurisdictions .................................................................................. 137
Fail Transaction If Registration Id Invalid .................................................................................................. 138
Imply Main Division Registration with Tax Registration Overrides ........................................................... 139
Limit Tax Inclusive To Extended Price ....................................................................................................... 140
Tax Include Round Up Tax ......................................................................................................................... 140
Push Tax Assist Location To Transaction Level .......................................................................................... 141

Chapter 5. TaxGIS parameters .......................................................................................................... 142

Alternative Region Type Lists .................................................................................................................... 144
Alternative Region Type Lists (Calc Override) ............................................................................................................................... 146
Approximate Tax Areas Historically .......................................................................................................... 147
Default Country Code For Address ............................................................................................................ 148
Filter Multi State Zip Codes ....................................................................................................................... 148

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide

Filter Postal Area Given No Zip .................................................................................................................. 149

Filter Postal Area Given Zip 5 .................................................................................................................... 150
Filter Postal Area Given Zip 9 .................................................................................................................... 151
Filter Postal County Area ........................................................................................................................... 152
Filter Postal Unincorporated Area............................................................................................................. 153
Match Prefix For Region Types .................................................................................................................. 153
Match Prefix For Region Types (Calc Override) ............................................................................................................................. 154
Maximum Full Addresses .......................................................................................................................... 154
Maximum Tax Areas .................................................................................................................................. 155
Maximum Tax Areas (Calc Override) ............................................................................................................................................. 155
Minimum Aggregate Confidence .............................................................................................................. 156
Number Of Address Cleansing Lookup Attempts ...................................................................................... 156
Use Special Characters .............................................................................................................................. 157
Retrieve Full Vertex Addresses.................................................................................................................. 158
Override default Canada postal code setting ([Link]) ........ 159
Required Region Types For Address .......................................................................................................... 159
Required Region Types For Address (Calc Override) ..................................................................................................................... 160
Retrieve Second Street Line in Address Cleansing .................................................................................... 161
Retrieve Second Street Line in Address Cleansing (Calc Override)................................................................................................ 162
Retrieve Cleansed Address ........................................................................................................................ 163
To Preload All Tax Areas And Jurisdictions ................................................................................................ 164
Use Address Cleansing .............................................................................................................................. 164
Use Address Cleansing (Calc Override).......................................................................................................................................... 165
Use Vertex Compression Logic City ........................................................................................................... 165
Use Vertex Compression Logic City (Calc Override) ...................................................................................................................... 166
Use Vertex Compression Logic Country .................................................................................................... 166
Use Vertex Compression Logic Country (Calc Override)................................................................................................................ 167
Use Vertex Compression Logic Main Division ........................................................................................... 167
Use Vertex Compression Logic Main Division (Calc Override)....................................................................................................... 168
Use Vertex Compression Logic Sub Division ............................................................................................. 168
Use Vertex Compression Logic Sub Division (Calc Override) ......................................................................................................... 169
User Defined Address Mappings ([Link]) .............. 169
How user-defined address lookup works ...................................................................................................................................... 170
How to set up user-defined address lookup ................................................................................................................................. 170
Best practice: When to create a user-defined address mapping file ............................................................................................ 171
Input fields in the text file ............................................................................................................................................................. 172
Best practice: Entering data in the text file ................................................................................................................................... 173
Guideline: Limit the number of entries in the text file associated with [Link]
............................................................................................................................................................................................... 174
Guideline: Troubleshooting warning messages............................................................................................................................. 174
Wait Time For Address Cleansing Retry .................................................................................................... 174
Setting time before refreshing the user-defined address mappings file
([Link])....................................... 175
TaxGIS Transaction Dump ......................................................................................................................... 175

Chapter 6. Custom Reports - VRA and Reports-related parameters .................................................. 176

Parameters for integration with Legacy Vertex Reporting & Analysis (Legacy VRA) ................................ 176
Set the COGNOS user name ([Link])........................................................................................................................... 177

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide

Set the COGNOS password ([Link]) ............................................................................................................................. 177

Turning report streaming on and off ([Link].) ............................................................. 178
Change the output for reports from a PDF file to a text file ([Link]) .... 178
Changing the appearance of standard reports ......................................................................................... 179
Setting bold body text ([Link]) ................................................................................... 179
Setting page width to accommodate Unicode characters ([Link]) .................... 179
Setting the plain body text style ([Link]) ................................................................... 179

Chapter 7. General Parameters ........................................................................................................ 180

Accumulator Cache Initial Years ................................................................................................................ 181
Accumulator Cache Refresh Delay ............................................................................................................ 182
Allow Historical Edits ................................................................................................................................. 182
Allow Tax Journal Export update date ([Link]) ........................................... 183
Auto Populate Search Results ................................................................................................................... 183
Cache Refresh Delay .................................................................................................................................. 184
Custom Label 1 -10 .................................................................................................................................... 185
Custom Label 2 .......................................................................................................................................... 185
Custom Lookup Label ................................................................................................................................ 186
Custom Lookup List ................................................................................................................................... 187
Default Business Event .............................................................................................................................. 187
Default Currency ....................................................................................................................................... 188
Default Currency Code .............................................................................................................................. 188
Default Freight Category Code .................................................................................................................. 188
Default Locale ............................................................................................................................................ 189
Default Taxability Drivers Sharing ............................................................................................................. 189
Default Transaction Type .......................................................................................................................... 189
Enabling accumulation .............................................................................................................................. 190
Jurisdictions ............................................................................................................................................... 190
Landing Page ............................................................................................................................................. 191
Always Return Effective Rate .................................................................................................................... 191
Calculation Time Limit ............................................................................................................................... 192
Limit the number of tax rules loaded ([Link]) ............. 193
Max Vendor Summaries ............................................................................................................................ 194
Max Category Mapping Summaries .......................................................................................................... 194
Max Certificate Summaries ....................................................................................................................... 194
Max Commodity Code Summaries ............................................................................................................ 195
Max Customer Summaries ........................................................................................................................ 195
Max Task Log Summaries .......................................................................................................................... 195
Max Tax Rule Summaries .......................................................................................................................... 196
Maximum Bracket Schedule Size ([Link]) .................................... 196
Maximum Calculation Iterations ([Link]).................................... 197
Maximum Posting Date Threshold ............................................................................................................ 197
Maximum Taxability Driver Summaries .................................................................................................... 198
Minimum Posting Date Threshold............................................................................................................. 198
Number of Threads for Retail Tax Extract ................................................................................................. 199

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide

Override the default list of allowed uploadable file types ([Link]) ............................ 199
Transactional Logging Threshold Limit ...................................................................................................... 200
Taxability Categories ................................................................................................................................. 201
Use Assisted Tax Date ............................................................................................................................... 201
Returns Export parameters ....................................................................................................................... 202
Suppress the Physical Origin Tax Area ID in the Returns Export ([Link]) ..................................... 202
Transaction Tester-related parameters .................................................................................................... 202
Always process basis apportionment ............................................................................................................................................ 203
Calculate Self-Accrual Indicator Default ........................................................................................................................................ 203
Show Tax Journal Button ............................................................................................................................................................... 204

Chapter 8. Batch Client Interface for O Series Parameters ................................................................ 205

Process flat file input via the Batch Client Interface in Data Management .............................................. 205
Polling frequency for batch calculations ([Link]) ......................................................................... 206
Setting the number of threads for batch calculation processing ([Link]) ....................................................... 206
Process database input through Batch Client Interface as a web service ................................................ 206
How to enable Batch Client Interface as a web service ................................................................................................................ 207
Web service parameters ............................................................................................................................................................... 207

Chapter 9. Exemption Certificate Management Parameters ............................................................. 215

Apply limited certificate if one taxability driver is satisfied ...................................................................... 216
Certificate Replacement for Tax Data Import ........................................................................................... 216
Certificate Validation ................................................................................................................................. 217
Company Logo ........................................................................................................................................... 217
Company Logo Alignment ......................................................................................................................... 217
Hide Certificate Validation Button ............................................................................................................ 218
Ignore Exemption Certificate expiration date ........................................................................................... 218
Max Certificate Summaries ....................................................................................................................... 218
Portal Certificate Approval ........................................................................................................................ 219
Require An Image For A Certificate ........................................................................................................... 219
User Signature ........................................................................................................................................... 220
[Link] .............................. 220
[Link] ........................................................................ 221
[Link] ............................................................................................................................... 221
[Link]........................................................................... 222
[Link] ............................................... 223
[Link] .................................................... 224

Chapter 10. Exemption Certificate Wizard Parameters ..................................................................... 225

ECW Rejection Letter Template Name ...................................................................................................... 225
ECW Rejection Letter URL ......................................................................................................................... 226
ECW Rejection Letter Subject.................................................................................................................... 226

Chapter 11. Certificate Center Parameters ....................................................................................... 227

[Link]............................................................................................................................................. 229
[Link] ................................................................................................................................ 229

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide

Client ID ..................................................................................................................................................... 230

Client Secret .............................................................................................................................................. 230
Sync Interval .............................................................................................................................................. 230
Sync Window Start Time ........................................................................................................................... 231
Sync Window End Time ............................................................................................................................. 231
Enable Sync................................................................................................................................................ 232

Chapter 12. Address Cleansing Parameters ....................................................................................... 233

How Address Cleansing works................................................................................................................... 233
Why does Address Cleansing have O Series and TaxGIS parameters? .......................................................................................... 234
Planning for Address Cleansing ..................................................................................................................................................... 235
Are you licensed for the Address Cleansing? ................................................................................................................................ 235
Is your infrastructure ready for Address Cleansing? ..................................................................................................................... 235
Do you want to enable Address Cleansing? .................................................................................................................................. 236
How do you define Address Cleansing processing order?............................................................................................................. 236
Do you want to retrieve cleansed addresses?............................................................................................................................... 237
What address do you want to retrieve? ........................................................................................................................................ 237
Do you want the process to continue if the Address Cleansing is unavailable? ............................................................................ 238
Address Cleansing Licensed ([Link]) .................................. 238
Continue If Address Cleansing Unavailable ............................................................................................... 239
Continue If Address Cleansing Unavailable (Calc Override) .......................................................................................................... 240
Address Cleansing Processing Order ......................................................................................................... 241
Address Cleansing Processing Order (Calc Override) .................................................................................................................... 242
Continue If Address Fails To Cleanse ......................................................................................................... 243
Continue If Address Fails To Cleanse (Calc Override) .................................................................................................................... 243
Retrieve Cleansed Address ........................................................................................................................ 244
Address Cleansing Service Timeout........................................................................................................... 245
Define the Dispatch Client for Address Cleansing
([Link]) ....................................................... 246

Chapter 13. Performance Tuning Parameters ................................................................................... 247

Java Virtual Machine ................................................................................................................................. 247
Oracle database installations .................................................................................................................... 248
Calculation Engine ..................................................................................................................................... 248
LookupTaxAreas Web service with TaxGIS................................................................................................ 249
Improve performance by loading data only once
([Link].load_datarelease_once) ................................................... 249
Wait Time For Address Cleansing Retry .................................................................................................... 250
Enable JMX monitoring technology ([Link]) ..................................................... 250

Chapter 14. Lightweight Directory Access Protocol (LDAP)................................................................ 251

Why use LDAP?.......................................................................................................................................... 251
How to integrate LDAP with O Series ........................................................................................................ 252
LDAP best practices ................................................................................................................................... 252
How LDAP parameters relate to the system partition and roles .............................................................. 253
1. Enable LDAP through the [Link] file. ................................................................................................................................... 254
2. Map the login connections for your LDAP administrator to parameters in the [Link] file.................................................. 255

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide

3. Map existing LDAP attributes for usernames and passwords in your LDAP repository to parameters in the [Link] file. ... 256
4. Map existing LDAP attributes for Vertex-defined partitions to parameters in the [Link] file. ............................................ 257
5. Map existing LDAP attributes for Vertex-defined roles to parameters in the [Link] file. ................................................... 258
6. Map existing LDAP attributes for Vertex-defined groups to parameters in the [Link] file. ................................................ 259
Example: How LDAP attributes map to Vertex configuration file parameters ......................................... 260
Required parameters for each step in LDAP implementation .................................................................. 262
LDAP integration scenarios ....................................................................................................................... 263
Set LDAP parameters for admin and sysadmin default logins....................................................................................................... 264
Set LDAP parameters for log in using Bind authentication in large LDAP stores ........................................................................... 265
Set LDAP parameters for log in using Bind authentication to large LDAP stores without Vertex partition and role information 266
Set LDAP parameters for log in using Bind authentication with the LDAP store ........................................................................... 267
Set LDAP parameters for log in using Comparison authentication with the LDAP store ............................................................... 268
Set LDAP parameters from the LDAP store to Vertex O Series ..................................................................................................... 269
LDAP parameters ....................................................................................................................................... 270
How to use LDAP parameters........................................................................................................................................................ 271

Chapter 15. Direct Data Movement .................................................................................................. 281

Direct Data Movement configuration parameters ................................................................................... 282
Configuring Direct Data Movement for use with your database .............................................................. 282
Oracle configuration...................................................................................................................................................................... 283
SQL Server configuration ............................................................................................................................................................... 283
DB2 configuration ......................................................................................................................................................................... 284
Postgres configuration .................................................................................................................................................................. 285
If you have more than one Tax Journal database.......................................................................................................................... 288

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
What's New in This Guide
This section describes the new features for the latest major release and all service releases.

What's new in this guide for 9.0 SR11

(September 2022)
New setting
With the Push Tax Assist Location to Transaction Level setting (see page 141), you have these
options for applying a line-item location assigned via Tax Assist:
• Use the default setting of true to promote the location to the transaction level, where it is
shared by all line items.
• Set this parameter to false to have the location apply only to the line item that triggered
the Tax Assist rule.

New configuration parameter

The [Link] parameter (see page 282) enables you to set the
segment size of journal data being moved to the Reporting database via the Direct Data
Movement feature. If this parameter is not added to the [Link] file, the default segment size
is 100000 records.

What's new in this guide for 9.0 SR10 (July

2022)
New setting
The new Allow Fair Market Value and Extended Price to have different signs (see page 121)
setting, when set to true, allows the fair market value and extended price to have different
signs, such as -100 and 100.

Documentation changes
Documentation of the [Link] configuration parameter (see page 98)was added,
including information about the O Series Configuration API that is new for this release.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 What's New in This Guide | 13

What's new in this guide for 9.0 SR9 (March

2022)
Delivery point validation
Vertex has disabled the Delivery Point Validation (DPV) service within Address Cleansing.
Although the setting for Use Address Cleansing DPV will continue to display temporarily in the
user interface, Vertex O Series no longer passes an address through the DPV service. The
address will continue to be cleansed through the Address Cleansing service.

Sync interval default interval value

Vertex shortened the default Certificate Center Sync Interval (see page 230) from 15 minutes to
5 minutes.

What's new in this guide for 9.0 SR8 (December

2021)
Direct Data Movement changes
Information was added about configuring Direct Data Movement with a Postgres database (see
page 285).

Certificate Center sync additions

If you license Vertex Certificate Center when it becomes available and set up a sync to O Series,
you can change the Certificate Center environment that is part of the sync using these
configurations:
[Link] (see page 229)
[Link] (see page 229)
Add both to change the environment, then remove both to resume syncing to the production
environment.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 What's New in This Guide | 14

What's new in this guide for November 2021

Settings changes
• When setting up taxpayer registrations, you can disable certain impositions from applying in
tax calculations for a jurisdiction. These impositions have a No Tax result. You can also
enable the Do Not Show NoTax Results setting to suppress No Tax results in XML responses.
Two new configuration settings enable O Series to return a No Tax result in the XML
response when that result applies to either a primary imposition or to an output notice or
invoice text code. The new settings are:
− Return No Tax elements for primary impositions (see page 125)
− Return No Tax elements with Output Notices or Invoice Text Codes (see page 125)
These settings override the Do Not Show NoTax Results setting so that impositions that are
specifically disabled are removed from the XML response while other No Tax results are
included in the response.
• If you license Vertex Certificate Center, settings were added to enable you to sync
information with Vertex O Series
Both of these values are needed to enable sync:
− Client ID (see page 229)
− Client Secret (see page 230)
If you change these values later, sync may be affected.
Related settings include:
− Enable Sync (see page 231)
− Sync Interval (see page 230)
− Sync Window Start Time (see page 231)
− Sync Window End Time (see page 231)
The sync interval, start, and end times are configured at the system level, not the partition
level.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 What's New in This Guide | 15

What's new in this guide for 9.0 SR5 (July 2021)

Settings changes
• The following data record limit settings are added to System > Administration > Settings.
These settings specify the maximum number of records that can exist in an O Series
instance, partition, or account.
− Taxpayer Limit (see page 95)
− Customer Limit (see page 92)
− Vendor Limit (see page 96)
− Taxability Driver Limit (see page 94)
− Taxability Mapping Limit (see page 95)
− Exemption Certificate Limit (see page 93)

Configuration file changes

• You can now add the [Link] configuration parameter (see page 221) to
[Link] to prevent New Customer from displaying as an option when you create a new
user for the Exemption Certificate Portal (ECP). Selecting New Customer during setup
creates a new customer record in Vertex O Series.
If the parameter is added and set to true, Existing Customer is the only option during ECP
user setup. You must enter a customer code for an existing Vertex O Series customer to
continue the setup.
• You can add the [Link] configuration parameter
(see page 159) to the [Link] file to return a full postal code for a Canadian jurisdiction in
Tax Area Lookup. Use this parameter in conjunction with Retrieve Full Vertex Addresses in
System > Administration > Settings.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 What's New in This Guide | 16

What's new in this guide for 9.0 SR4 (April

2021)
Settings changes
• The Accrue Assisted Line Items as Independent Line Items setting (see page 121) is added to
System > Administration > Settings. This setting provides options for accrual processing of
transactions with child line items that are created by an allocation.
• The Log Level for Invalid Address Exceptions setting (see page 49) is added to System >
Administration > Settings. Use this setting to override the system logging threshold for
invalid addresses that are passed to Vertex O Series.

Configuration file changes

• The oauth.client_secret configuration parameter, which defines the client password for
OAuth token validation, supports bcrypt 2a encryption. The default password is now
encrypted in the [Link] file for new installations.

What's new in this guide for 9.0 SR3 MP2

(January 2021)
Two parameters were added to support the
[Link] parameter:
• [Link]

• [Link]

The parameters can be added to the [Link] file. They apply only if the value of
[Link] is set to true.

The new parameters enable you to distinguish appropriately between certificates that have
similar criteria by reading certificate details from the database rather than the cache.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 What's New in This Guide | 17

What's new in this guide for 9.0 SR3 (October

2020)
Settings changes
The Return Detailed Tax Calculation Timings setting (see page 98) is added to System >
Administration > Settings. This setting returns additional timing metrics in XML (SOAP) and JSON
(REST) responses to service calls for tax calculation and tax area lookup to assist in
troubleshooting performance issues.

Configuration file changes

• You can add the oidc.post_logout_redirect_uris configuration parameter (see page 72) to
the file. Use this parameter to redirect users to a specified URL after a successful logout
when no post_logout_redirect_uri query string is provided.
• The [Link] parameter (see page 51) is added to the [Link] file and enables
the mapping of metadata to a display value that is written to the log.
• The [Link] parameter (see page 49) is added to the [Link] file and
enables the Partition ID (where applicable) to be added to each log message. By default, the
parameter is set to true.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 What's New in This Guide | 18

What's new in this guide for 9.0 SR2 MP2

(September 2020)
Configuration file changes
Parameters for managing the number of idle database connections were added to the [Link]
file:
• [Link] - Defines the time interval for an O
Series service to monitor and close idle connections in an O Series managed database
connection pool. The parameter applies to each O Series database in use.
• [Link] - Defines the maximum number of
connections that can remain idle in an O Series managed database connection pool. The
parameter applies to each O Series database in use.
• [Link] - Defines the time in minutes that O Series managed
connections in an O Series managed database connection pool can remain idle before being
identified as candidates for closure. The parameter applies to each O Series database in use.

What's new in this guide for 9.0 SR2 (July 2020)

Settings change
The new setting for lease taxes in the state of Alabama - Disable Gross Receipts Tax Imposition
Type Inclusion Rules in Alabama - enables the disabling of inclusion rules specific to the gross
receipts imposition type in Alabama during the calculation process.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 What's New in This Guide | 19

What's new in this guide for 9.0 SR 1 (March

2020)
This guide includes the following additions:

Configuration file ([Link]) changes

The following parameters were added to the [Link] file in support of SAML 2.0 integration
for federated security (see page 69):
• [Link] (see page 82)
• [Link] (see page 82)
• [Link] (see page 83)
• [Link] (see page 83)

Settings changes
The following settings are added to System > Administration > Settings:
• Transactional Logging Threshold Limit enables you to restrict individual transactions from
overriding the default logging threshold beyond an allowable level. The selected value for
this setting represents the lowest-level logging threshold that a transaction can specify to
override the default logging threshold. Available values are FATAL, ERROR, WARNING, OPS,
TRACE, and DEBUG.
• Minimum Posting Date Threshold enables you to specify the earliest date for which a
transaction posting date is valid.
• Maximum Posting Date Threshold enables you to specify the latest date for which a
transaction posting date is valid.
• Use Assisted Tax Date enables you to specify the date that determines the effective Tax
Assist rules to apply to a calculation:
− When the value for this setting is true, Vertex O Series uses the available assisted tax
date.
− When the value for this setting is false, Vertex O Series uses the original line-item date.
This setting applies at the partition level.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 What's New in This Guide | 20

What's new in this guide for 9.0 (August,

December 2019)
New settings
• The new Enabling accumulation setting, when selected, enables the accumulation of
transactions.
• The Accumulator Cache Initial Years setting enables you to load data into the Accumulator
cache based on the specified number of years, instead of loading all data for all years. For
example, with the default setting of 1, the system loads only cached data that is dated one
year from the As of Date. For example, if the As Of Date is 01/01/2020, the system loads
only cached data from 01/01/2019 and later.
• The Accumulator Cache Refresh Delay setting enables you to define the minimum number of
milliseconds between accumulator cache refresh updates. Possible values are 100 to
172800000 (48 hours). Caches are refreshed only during heartbeat processing. Refresh
values are always rounded to the next whole number increment of master controller
heartbeats. Vertex recommends that you keep the default value (300000) for this setting.
• The Ignore Exemption Certificate Expiration Date setting enables you to keep an exemption
certificate active despite its having reached its expiration date. Set this parameter to true to
ignore the exemption certificate expiration date and include the certificate in transaction
processing. The default value is false. Reporting and compliance letter functionality are not
affected by this setting.

Configuration file ([Link]) changes

• A number of parameters were added in support of federated security, including properties
for OAuth 2.0 and SAML 2.0 integration. These parameters can be found in the Federated
security parameters (see page 69) section of this guide.
• The following parameters were added in support of login security:
− [Link]

− [Link]

− [Link]

− [Link]

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 What's New in This Guide | 21

• The default value for the [Link] parameter is now 7. This parameter defines
the maximum number of days that log files are retained before they are automatically
deleted.
• The default value of the [Link] parameter was changed from
false to true. When set to true, a Tax Journal Export task moves only records that have
changed since the last posting update.
• The following parameters were moved from the [Link] file to the [Link]
file:
− [Link]

− [Link]

− [Link]

− [Link]

The installation program automatically assigns the parameter values based on user input
during the installation process.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
Preface
This preface contains information about Vertex services, Vertex® Indirect Tax O Series®, and
available documentation.

About Vertex and our services

Vertex Inc. is a leading tax software and services provider that empowers global commerce.
Vertex connects customers and partners across all industries to deliver the world’s most trusted
tax solutions for businesses to grow with confidence.
Vertex provides cloud-based and on-premise solutions that can be tailored to specific industries
for every major line of indirect tax, including sales and consumer use, value added, and payroll.
Headquartered in Pennsylvania with offices worldwide, Vertex employs over 1,000 professionals
and serves companies across the globe.

Vertex has offices in King of Prussia, Pennsylvania; Naperville, Illinois; London, United Kingdom;
and São Paulo, Brazil. For office addresses and telephone numbers, go to
[Link]

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Preface | 23

Vertex services
Vertex provides the following services:
D

For... Go to...

Technical questions about your Vertex Customer Support

products Web: [Link] Navigate to
Support > Create Case.
Phone: 800.281.1900 or 610.642.4210

Documentation, downloads, The Vertex Community

forums, cases, and Web: [Link]
up-to-the-minute information
about tax rates, tax rules, and
jurisdictions
Questions about your licensing Vertex Account Services
agreement, license renewal, and Phone: 800.355.3500 or 610.640.4200
invoicing arrangements for your
Web: [Link]/contact
products
Regional training classes, Vertex Training
web-based training classes, or Phone: 877.455.2645 (Monday through Friday, 8:15
on-site training at your facility A.M. to 8:00 P.M. United States Eastern Time)
option #2
Web: [Link]/training

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Preface | 24

About Vertex O Series

The Vertex O Series platform provides an advanced architecture for integrating a broad range of
sales tax, consumer use tax, and value added tax compliance features into a single, seamless
application suite.
By using object-oriented techniques and web technologies – such as XML, HTML, SOAP, and
Java – Vertex O Series efficiently combines functionality for tax calculation and data
maintenance with an external interface to a financial host system.
The Vertex O Series suite offers the following products:
• Vertex® Indirect Tax O Series® for calculating tax on business transactions. To help you
achieve tax compliance, it calculates tax based on Vertex-supplied research and your
customizations of jurisdiction rates, rules, and exceptions.
• Vertex Certificate Center, a cloud-based exemption management system to organize and
track the certificates provided by your customers. You can create or upload certificates, or
accept them directly from your customers via an online wizard. An automated data sync
supplies Certificate Center exemptions to O Series to exempt tax during transaction
calculations.
• Vertex® Exemption Certificate ManagerTM (ECM), a legacy tool that automates the collection,
validation, and maintenance of tax documents such as exemption certificates, resale
certificates, and direct pay permits. This product license includes the Exemption Certificate
Portal (ECP), which enables your customers to print certificates at a remote location while
you manage those certificates from within Vertex O Series.
• Vertex® Exemption Certificate Wizard (ECW), a certificate creation tool that presents your
customers with a series of prompts and questions for creating a certificate.
• Vertex® Indirect Tax for Retail (Vertex Retail), which coordinates the exchange and
maintenance of tax data for Point-of-Sale (POS) systems between a central headquarters
and multiple POS locations.
• Vertex® Indirect Tax for Leasing (Vertex Leasing), a tax calculation solution for major leasing
software vendors and their enterprise customers within the equipment and vehicle leasing
industries.
• Vertex® Indirect Tax for Communications (Vertex Communications), a tax calculation solution
that delivers tax rates and rules for various communications scenarios for the United States,
its territories, and Canada.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Preface | 25

• Vertex® Indirect Tax for Brazil (Vertex for Brazil), a tax calculation solution that delivers the
tax rules, tax rates, and place of supply logic for calculating indirect taxes at the federal,
state, and municipal levels in Brazil.
• Vertex® Indirect Tax Returns (Vertex Returns), an automated, multinational, and multistate
tax returns solution for companies that report value added tax and sales and use tax to
various jurisdictions. Vertex Returns produces signature-ready returns.
• Vertex® Indirect Tax for Hospitality, a tax calculation solution for the hospitality industry that
provides hospitality-related tax rates and rules on the Vertex O Series platform.
• Address Cleansing to improve the granularity of Tax GIS database searches for United States
address data and provide more precise jurisdiction assignments. This service assigns
nine-digit ZIP Codes, converts addresses to a standard format, and corrects address errors.
You can purchase this service separately as an add-on feature.
• Latitude/Longitude Services to enter latitude and longitude coordinates for United States
jurisdictions to identify applicable Tax Area IDs and jurisdictions for tax calculation.
Some products are available as On-Demand deployments. These software-as-a-service, hosted
models accelerate implementation and reduce hardware, database, and other support
requirements. For more information, refer to the Administration Guide, On-Demand
Implementation Guide, User's Guide, or Online Help.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Preface | 26

Finding information about Vertex Indirect Tax O

Series
Vertex provides documentation for the tasks that you must complete to use O Series
successfully. Most documentation is available on the Vertex Community
([Link]
Note: You can also use the Vertex Community to access the online knowledge base, open a
case, or visit the Communities where you can communicate with other Vertex users about
tips, tricks, and best practices.

Preparing your O Series instance

For this task Use this documentation

Planning your implementation for technology and Planning Guide

tax compliance.

Installing and deploying the O Series platform and Installation Guide

loading O Series.
Configuring O Series. Configuration Parameters Reference Guide
Performing administrative tasks, such as defining Administration Guide
user access and roles, applying data updates,
moving data, and monitoring performance.

Integrating O Series with your host system

For this task Use this documentation
Using XML messages to integrate O Series and your XML Integration Guide
host system.

Using the Java interface to integrate O Series and Java Integration Guide
your host system.

Managing O Series tax data that is used in a calling O Series Web Services Integration Guide
application.

Using the Batch Client Interface to process groups Batch Client Interface Integration Guide
of transactions without writing an interface
between O Series and your host system.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Preface | 27

Maintaining O Series
For this task Use this documentation

Managing O Series data, customized data, and Tax Administration Guide

Journal data. O Series Help
User's Guide
Performing monthly updates. Administration Guide
Upgrading to the latest major version of O Series. Upgrade Guide

Using O Series for indirect tax

For this task Use this documentation
Setting up taxability information and your O Series Help
structure, such as the following: User's Guide
• Taxpayers, customers, and vendors
• Certificates
• Taxability categories
• Taxability drivers
• Tax rules
Generating standard reports and Custom Reports - O Series Help
VRA data extract reports. User's Guide

Using the command line or web services to O Series Client Utilities User's Guide
perform activities for Data Management, Custom
Reports - VRA data extract, and file transfer.
Using required data file formats to move data Tax Data File Formats Handbook
between O Series and your host system.
Reviewing formats in which you can view the Reporting Database Views Tipsheet
Reporting database data.

Managing certificates
For this product Use this documentation

Certificate Center Certificate Center Help

Getting Started with Certificate Center
Exemption Certificate Wizard Integration Guide

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Preface | 28

For this product Use this documentation

Exemption Certificate Manager O Series Help

User's Guide

Exemption Certificate Portal Exemption Certificate Portal User’s Guide

Exemption Certificate Wizard ECW Integration Guide
ECW Portal Help

Using O Series with Vertex Returns

For this task Use this documentation
Exporting data for returns. O Series Help
User's Guide

Using the required header and export file formats Returns Export Data File Format Handbook
to move data between O Series and Vertex Returns
to create ready-to-file returns.
Using the required header and export file formats VAT Returns Export Data File Format Handbook
to move data between O Series and Vertex Returns
to create ready-to-file VAT returns.
Setting up data transfers and understanding data Returns Reconciliation Guide
discrepancies between O Series and Vertex
Returns.

Using O Series On-Demand

For this task Use this documentation

Understanding your responsibilities for setting up On-Demand Getting Started Guide

and for implementing your hosted O Series
environment.
Using O Series in your hosted environment. O Series Help
Supporting your decision-making during the On-Demand Implementation Guide
onboarding process, reviewing configuration
settings, and managing your hosted instance.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Preface | 29

Using O Series with industry-specific and jurisdiction-specific data

For this product Use this documentation
Vertex Indirect Tax for Retail Retail Getting Started Guide (LITE)
Select the guides that are applicable to your Retail Retail Getting Started Guide (RTE)
product. Retail Installation and Administration Guide
(LITE)
Retail Installation and Administration Guide
(RTE)
Retail Tax Extract Integration Guide
Vertex Indirect Tax for Leasing Vertex Indirect Tax for Leasing Planning Guide
Administration Guide
O Series Help
Vertex Indirect Tax for Hospitality Vertex Indirect Tax for Hospitality Planning Guide
O Series Help
Vertex Indirect Tax for Brazil Brazil Guide

Vertex Communications Vertex Communications Guide

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Preface | 30

About this guide

This guide is designed for the following audiences:
• The system administrator who maintains the O Series software and databases. The system
administrator should be familiar with implementing new hardware and software, network
management, databases, and security.
• The person who is responsible for managing and editing the Vertex configuration file
([Link]).
• Anyone who is installing and configuring the Vertex O Series platform.
This guide describes what you need to know to do the following:
• Manage the integrity of the [Link] file
• Set configuration parameters
• Set performance parameters
• Set Address Cleansing parameters, if applicable
• Set LDAP parameters, if applicable
• Set Vertex O Series Tax Data Management Plug-In parameters, if applicable
Vertex product documentation covers only the software functionality and usage. For
information about scenarios outside the documented functionality, visit the Vertex Community
([Link]
To provide questions and/or feedback, email documentation@[Link].

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
Chapter 1. Configuration Overview
This chapter describes the high-level aspects of configuring Vertex O Series.

In this chapter
The three ways to set configuration information .........................31
What are Preferences? .................................................................32
What are Settings? .......................................................................32
The O Series configuration file and O Series On-Demand ............33
Guidelines for configuration security ...........................................33
Types of parameters you can change ...........................................35
Managing the O Series configuration file .....................................36

The three ways to set configuration information

You can set configuration information on the O Series user interface by clicking Settings, clicking
Preferences, or by editing the configuration file ([Link]).

In this reference guide, each parameter, preference, or setting is marked with a symbol that
indicates how to change its value:
• Settings that can be changed on the O Series user interface are identified by . The
settings that you can view depend on your assigned role. If you have questions, ask your
system administrator.
• Preferences that can be changed on the O Series user interface are identified by . The
preferences that you can view depend on your assigned role. If you have questions, ask your
system administrator.
• Parameters that can be changed only by editing the [Link] file are identified by .
Only those O Series users who have been granted network permissions to both access and
edit the [Link] file can modify this file.

Where do you find Settings and Preferences?

Preferences are accessed via the System > Administration > Preferences submenu. Settings are
accessed via the System > Administration > Settings submenu.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 1. Configuration Overview | 32

What are Preferences?

Preferences are the specific system settings in Vertex O Series that enable you to customize the
values that are presented for locales (geographic regions), currency rate, transaction types,
certificates, taxability, and jurisdictions.
The settings in Preferences, either the original default values or any override values that you
defined, may impact the available selections in O Series features such as the following:
• Taxpayers
• Customers
• Vendors
• Certificates
• Calculation Tax Rules
• Basis Rules
• Impositions
• Transaction Tester

What are Settings?

The Settings feature enables system administrators and other authorized users to easily review,
set, and manage a subset of O Series configuration settings on the O Series user interface.
The Settings feature includes parameters that are related to the following:
• Calculation
• Tax area lookups
• Proxy servers
• Certificate management

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 1. Configuration Overview | 33

The O Series configuration file and O Series

On-Demand
After your initial account setup, you or your backup Technical Lead can request changes to your
configuration parameters by submitting a case.

Changing the name of the Vertex configuration file (VertexConfigFile)

This system parameter is used to override the configuration file name. The name of the
directory must be absolute and delimited with a forward slash.
This directory name must be defined with a D option on the JAVA command line. This directory
name is not used in the configuration file.
Default = none

Guidelines for configuration security

Because of the type of configuration and performance parameters that you can change on the O
Series user interface or in the [Link] file, you must adopt appropriate security measures to
protect the integrity of your configuration.

Back up the [Link] file

Settings in the [Link] file, whether Vertex-defined or user-defined, override any
corresponding default settings in the O Series code itself.
Vertex highly recommends that you create a backup of the [Link] file before making any
modifications. Store this backup file in a safe location.
A backup copy of the [Link] file provides the following:
• Continuity in the O Series operations in case the original file is not usable.
• Consistency of parameters settings in case the original file is not usable.
• An audit trail of the [Link] file changes over an extended period of time. This audit trail is
helpful in troubleshooting.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 1. Configuration Overview | 34

Limit the number of users who can change configuration data

Protecting the [Link] file includes limiting access to the file. Your network administrator can
limit access by doing the following:
• Placing the [Link] file in a nonshared directory to protect the integrity of its contents
• Carefully and selectively granting network permissions to those users who can modify the
[Link] file or can edit Settings and Preferences.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 1. Configuration Overview | 35

Types of parameters you can change

The following table provides an overview of the types of Vertex O Series configuration
parameters:
Parameter Description
group
General Use these parameters to define system caching, profiling, and logging. Some parameters in this
parameters group also enable auditing.
Calculation Use these parameters to define Calculation Engine performance and calculation results. These
Engine parameters also enable you to define Tax Area Lookups as part of the calculation.
parameters
Data Use these parameters to define the content, file location, and performance of Data
Management Management activities. These activities include the following:
parameters • Purging the Reporting database
• Exporting the Tax Journal to the Reporting database
• Purging the Tax Journal
• Performing a Returns export
• Importing Tax Data
• Exporting Tax Data
• Performing a Data Update
These parameters also enable you to define a data delimiter for Tax Data import/export files.
Performance System monitoring using JMX through the jconsole interface enables you to gather statistics
parameters about the internal workings of O Series. Use these parameters to enable the JMX technologies
for reporting and diagnostic analysis.

Reports Use these parameters to define the type of report output (text or Postscript Data file) as well as
parameters limit the number of transactions in detail reports.

Returns Export Use these parameters to define when a database commit occurs and the directory location to
parameters which Returns files are exported.
Taxability Use these parameters to customize taxability precedence for Sales (Supplies) and Procurement
precedence transactions.
parameters
Vertex® Use these parameters to define the Tax Area Lookup performance. Some parameters in this
TaxGIS™ group enable you to define confidence level indicators for your Tax Area Lookup. Other
parameters parameters enable you to define Vertex logic for performing Tax Area Lookups.

Transaction Use these parameters to define the performance of Transaction Tester. For example, one
Tester parameter in this group enables you to display the Post To Journal button in the Transaction
parameters Tester.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 1. Configuration Overview | 36

Parameter Description
group
Web service Use these parameters to define the location of the Vertex XML schemas and to identify
parameters whether schema validation is enabled for incoming XML messages.

Address Address Cleansing is an optional service that enables you to send a US street address, city,
Cleansing state, and ZIP Code and receive a cleansed address containing a nine-digit ZIP Code. The
parameters nine-digit ZIP Code enables Vertex® TaxGISTM to more precisely assign a Tax Area ID and
provides faster transaction processing. Use these parameters to define how Address Cleansing
processing works with your O series system.

LDAP-related Use these parameters to integrate your LDAP system with O Series.
parameters
O Series to Tax Use these parameters to write Tax Journal data in the wide format for ingestion into Vertex®
Data EnterpriseTax Data Preparation and other tax data repositories.
Preparation
Connector
parameters

Managing the O Series configuration file

Vertex sends the configuration file to you with the most appropriate default settings for your
configuration parameters. O Series includes configuration parameters that you can use to
customize your system. The [Link] file, which can be edited with any text editor, is located
in the Vertex Home/config directory. Vertex recommends that you make no changes to the
[Link] file until after you have completed the installation successfully.

How [Link] settings impact system performance

Before you change the default settings for any configuration parameter, consider the
performance or tax calculation implications of your change. Modifying parameter settings may
degrade system performance. Always back up the [Link] file before editing. For questions
about specific parameter changes, contact Vertex Product Support.

Are all parameters included in this guide?

Not all parameters in the [Link] are documented in this guide. Undocumented parameters
are used for internal Vertex development and testing, and should not be modified unless you
have been specifically directed to do so by a Vertex Product Support analyst or Vertex
Consulting.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 1. Configuration Overview | 37

Editing the [Link] file

Complete the following steps to edit a parameter in the [Link] file:
1. Access the [Link] file on your network.
2. Use a text editor to do the following:
a. Open the [Link] file.
b. Locate and make your text changes to your specific parameters.
c. Save the [Link] file.
3. Stop your web application service.
4. Restart your web application service to make the changed [Link] file effective.
Track your changes to the [Link] file and the backup files.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 1. Configuration Overview | 38

Setting transactions in the Transaction Tester to post to the Tax Journal

Transaction Tester is a window to the Vertex Calculation Engine. Using the Transaction Tester,
you can replicate transaction requests as sent from your host system and then review the
results from the Calculation Engine. Use the Transaction Tester to ensure that you are getting
the appropriate tax-calculation results, based on the tax rules and rates for the transaction data
that you are sending.

Edit the Show Tax Journal Button setting when you want to display the Post to Journal button in
Transaction Tester.
This setting defines when the Post To Journal button displays in the Transaction Tester. When
the check box is selected, the value is true. When the check box is cleared, the value is false.
When the value is set to true or if the user has permission based on a user-defined role, the
Post to Journal button displays in the Transaction Tester for all financial events. Do not manually
post the following events to the Tax Journal:
• Quotation
• Purchase Order
• Invoice Verification
• Evaluated Receipts Settlement
If the value is set to false, the Post To Journal button does not display in the Transaction
Tester.
If you want to display this button only for specific users, grant them permissions under their
specific role. For more details about these permissions and roles, refer to the O Series Help.
Note: Permission to post to the Tax Journal is not included with any Vertex-supplied roles.
Caution: If you manually write transactions to the Tax Journal using Post to Journal, this
activity could result in your Tax Journal record being out of synchronization with
your host system.
Default = false

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 1. Configuration Overview | 39

Application Log file

The Application Log files record messages that are generated by the O Series application code.
You can forward one or more of these files to Vertex Customer Support when you are
troubleshooting an issue in O Series. The application name prefix helps when locating the error
message that is associated with an issue.
The log file that contains Vertex O Series application messages is named
[Link]-mm-dd.n

where:
server-name is the server host name or IP address

application-name is the Vertex O Series application that generated the message or error

yyyy is the year in which Vertex O Series created the log file

mm is the month in which Vertex O Series created the log file

dd is the day on which Vertex O Series created the log file

n is the sequence number of the log files that Vertex O Series created on the same day

When the log file reaches the file-size limit that is specified in the Vertex configuration file
([Link]), Vertex O Series creates a new log file.
Edit the [Link] (see page 43) parameter to define the level of detail in Vertex
O Series log files.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 1. Configuration Overview | 40

Set message at top of log file ([Link])

This parameter enables the user to log one or more unique messages at the top of each log file.
The parameter is in this format:
[Link]=xxx

where:
XXX is the unique message to be placed at the top of the log file

For example, to indicate which deployment created the log, use this parameter:
[Link]=INSTANCE1
The value can be any length and can use alphanumeric or special characters.
To log more than one unique message, use this parameter format:
[Link].n=xxx
where:
• n is the number of the unique message

• XXX is the unique message to be placed at the top of the log file

For example, to include two unique messages, use:

[Link].1=PERMANENTMESSAGE
[Link].2=TEMPORARYMESSAGE
There is no default value for this parameter.

Set the number of days to retain log files ([Link])

This parameter setting defines the maximum number of days that log files are retained before
they are automatically deleted.
The parameter is in this format:
[Link]=xxx

where:
xxx is the number of days to retain log files.
Default = 7

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 1. Configuration Overview | 41

Multiple Reporting databases

If you have more than one Reporting database, you need to identify the datasource that each
one uses. You associate datasources with the Reporting database by using the
[Link].RPT_DB parameter. Each Reporting Database reference has a unique
description appended to the parameter name. For example, each Reporting database
connection is identified as
[Link].RPT_DB.REPORTING_DATABASE_DESCRIPTION.

The REPORTING_DATABASE_DESCRIPTION is defined within the connection parameters that is

included within the {}. For example, review the following settings for Reporting databases for
the 9.x, 8.x, and 7.x versions of O Series:
[Link].RPT_DB={url="jdbc:oracle:thin:@tpsor[Link]orcl",euser="f7Y2dCm3m
Gt+4D",epassword="f7Y2dCm3mGt+4D", maxConnections="25", pooling="true",
maxBlockTime="30", description="Current 9.x Reporting Database"}
[Link].RPT_DB.PRIOR_RELEASE1={url="jdbc:oracle:thin:@tpsor[Link]orcl",e
user="f7Y2dCm3mGt+4D",epassword="f7Y2dCm3mGt+4D", maxConnections="25", pooling="true",
maxBlockTime="30", description="8.x Reporting Database"}
[Link].RPT_DB.PRIOR_RELEASE2={url="jdbc:oracle:thin:@tpsor[Link]orcl",e
user="f7Y2dCm3mGt+4D",epassword="f7Y2dCm3mGt+4D", maxConnections="25", pooling="true",
maxBlockTime="30", description="7.x Reporting Database"}

If you are using the Custom Reports - VRA data extract feature and you have set this parameter
for multiple Reporting databases, you can view the database descriptions from the Datasource
drop-down list on the O Series user interface when you create an extract. For more details
about adding a data extract definition, refer to the O Series Help.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 1. Configuration Overview | 42

Database-related parameters
Edit the [Link].logical_database_name parameter to do the following:

Define database connection strings

These parameter settings enable you to define Vertex database connections using alias
connections or JBDC data sources. The O Series installation program initially sets connections
for the five O Series databases.

Identify multiple Tax Journals when you have more than one Calculation Engine
If you have more than one Calculation Engine, you need to identify the Tax Journal that each
one uses. The Tax Journal that is associated with the O Series user interface uses
[Link].JOURNAL_DB.main with a precedence indicator appended as follows:
precedence=0. Each subsequent Tax Journal reference has a unique suffix appended to the Tax
Journal name and a precedence indicator that increments by one. For example, the first Tax
Journal is identified with this parameter: [Link].JOURNAL_DB.alt1 with a
precedence=1. Additional Tax Journals (N) are identified with this parameter:
[Link].JOURNAL_DB.alt1+N with a precedence=1+N.

Clone O Series databases

Because cloning O Series databases provides an exact O Series database copy, the exact same
database users and passwords are available initially. If there is a need to change the users
and/or passwords, then update the [Link] file to change the users and passwords for the
connection strings to the five O Series databases.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 1. Configuration Overview | 43

Define the system logging threshold ([Link])

This parameter setting defines the threshold for the logging service for the entire system.
Vertex recommends that you set this parameter after installation.
All messages that do not meet this threshold are discarded. Possible logging thresholds include:
• FATAL - logs any system condition or event that jeopardizes system integrity, such as
allocation failures, disk space errors, or major database problems.
• ERROR - logs all system and application errors.
• WARNING - logs any
system condition or event that is abnormal, but poses no risk to stability,
performance, or answer quality.
• OPS - logs major system events, such as starting up or shutting down of major system
components or services. An OPS threshold returns messages from the OPS level and higher.
Vertex recommends you use this level logging threshold.
• TRACE - logs entry and exit points of substantial classes and services.
• DEBUG - logs a detailed description of software execution.
• NONE - discards all messages without logging.
Default = OPS

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
Chapter 2. Setting the Level of System
Information in Log Files
Set the following parameters to define the level of system information in the O Series log files.

In this chapter
Setting the level of system error messages ..................................44
Providing additional details about XML schema issues in the log file
([Link]) ....................................44
Transaction Dump ........................................................................45
Defining logging levels for Java exceptions
([Link]) ..........................................................46
[Link] ...............................................................................46
How to override transaction-level details in the log file ...............47
Echo log messages to the console ([Link])...........47
Set the amount of disk space for log files ([Link])48
Set the number of hours a log is kept open ([Link]) 48
Set the maximum size of a single log file ([Link]) ....48
Log the partition ID ([Link]) ..............................49
Log Level for Invalid Address Exceptions ......................................49
Map metadata to a display value ([Link]) ..................51

Setting the level of system error messages

The [Link] (see page 43) parameter defines the level of system events that
generate error messages. The default value of OPS defines major system events, such as starting
up and shutting down major components.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 2. Setting the Level of System Information in Log Files | 45

Providing additional details about XML schema

issues in the log file
([Link])
The [Link] parameter enables you to provide additional details
about XML schema-related issues to the log file.
This setting indicates whether schema validation is enabled for incoming XML messages. If you
want to validate your XML messages, the schema location in the XML files must match the
location in which the Vertex XML schema is deployed. The XML schemas are installed with
Vertex O Series.
Schema validation affects performance and should be disabled in most production
environments. However, during integration or other testing, schema validation can be useful in
determining the root cause of errors.
Possible settings are true (to enable) and false (to disable). When the check box is selected, the
value is true. When the check box is cleared, the value is false.
Default = false

Transaction Dump
This setting enables dumping of transactions in XML format to the log file ([Link])
before and after calling the calculateTax method.
Possible values are true (to enable) and false (to disable). After you enable this setting,
transaction dumping continues until you disable it. This setting is best used in a test or
development environment.
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = false

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 2. Setting the Level of System Information in Log Files | 46

Defining logging levels for Java exceptions

([Link])
This parameter setting enables you to change the logging level at which Vertex O Series records
Java exceptions.
Logging exceptions, such as Vertex system exceptions and JVM exceptions, are logged as FATAL.
All other exceptions are logged as ERROR. Use multiple occurrences of this parameter to change
the logging level for multiple Java exceptions. To set this parameter, append the name of the
Java exception class for which you want to change the logging level.
For example:
[Link]=DEBUG indicates that this
specific Java exception class is logged at the DEBUG level in the Log File.
There is no default value for this parameter.

[Link]
This parameter defines the location for log files. Normally, the log directory is used only for log
files that the system generates.
If other files are stored in the log directory, the rate at which log files are purged can be
unpredictable. The name of the directory must be absolute and delimited with a forward slash.
Default = VertexRoot/log

How changing the default directory for the log files relates to the
[Link] file
If you change the directory location for the log files from the default directory
(VertexRoot/log), you need to make sure that the Log File Information window accesses that
directory. Update the [Link] (see page 46) parameter in the [Link] file with the new
directory location for your log files.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 2. Setting the Level of System Information in Log Files | 47

How to override transaction-level details in the

log file
You can override the setting for the level of detail in the log file for any given transaction. The
system administrator for the host or ERP system can set different levels of detail by editing the
XML request. The default level of detail for the log file defined in [Link] is OPS.
In this example, the data elements in the XML request override the global level detail that is set
in [Link] for the Log file. It sets the level of detail to Trace for this particular transaction in
this particular package:
<MessageLogging returnLogEntries="true">
<OverrideLoggingThreshold thresholdScope="[Link].
[Link]">TRACE</OverrideLoggingThreshold>
</MessageLogging>
This XML fragment must occur immediately before the closing tag of the tax calculation request
message – that is, before </InvoiceRequest>.

Echo log messages to the console

([Link])
This parameter setting indicates whether log messages are echoed to the console. This flag is
normally set only for detailed debugging efforts.
Possible settings are true (to enable) and false (to disable).
Default = false

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 2. Setting the Level of System Information in Log Files | 48

Set the amount of disk space for log files

([Link])
This parameter setting defines the maximum amount of disk space in megabytes for log files in
the directory defined by [Link].
When this limit is reached, log files are automatically purged starting with the oldest files.
Purging continues until the disk space is below this limit.
Default = 100

Set the number of hours a log is kept open

([Link])
This parameter setting defines the maximum number of hours that a log file can be kept open.
When this limit is reached, the log file is automatically closed and a new log file is opened.
The [Link] parameter may close a log file before this limit is reached.
Default = 12

Set the maximum size of a single log file

([Link])
This parameter setting defines the maximum file size in megabytes for a single log file. When
this limit is reached, the log file is automatically closed and a new log file is opened.
The [Link] parameter may close a log file before this limit is reached.
Default = 10

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 2. Setting the Level of System Information in Log Files | 49

Log the partition ID ([Link])

This parameter defines whether the user's partition is included as a log header. When set to
true, the Partition ID (where applicable) is added to each log message. If you use partitions, this
parameter enables you to track events and activity in specific partitions. To turn this feature off,
set this parameter to false.
The parameter is in this format:
[Link]=true
Default = true

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 2. Setting the Level of System Information in Log Files | 50

Log Level for Invalid Address Exceptions

Use this setting to override the system logging threshold for invalid addresses that are passed to
Vertex O Series. Consider if the number of logging events for invalid addresses can impact your
throughput and change the log level accordingly. Here are the possible settings:
• FATAL
• ERROR (default for system scope)
• WARNING
• OPS
• TRACE
• DEBUG
• Use System Setting (default for partition scope and available for partition level only)
This setting works in conjunction with the system logging threshold parameter, which is
[Link] in the [Link] file. Here's how the comparison works:

• If the invalid address log level (for example, TRACE) is lower than the system logging
threshold (for example, OPS), Vertex O Series does not record occurrences of invalid
addresses to the log file.
• If the invalid address log level (for example, WARNING) is the same as or higher than the
system logging threshold (for example, OPS), Vertex O Series does record each occurrence of
an invalid address in the log file.
The Master Administrator can set this parameter at the system level and across all partitions.
The Partition System Administrator can override the system-level setting for an individual
partition. Note that the partition-level setting needs to be adjusted only if it is different from the
log level for the whole system.
Default = ERROR (for System scope), Use System Setting (for Partition scope)

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 2. Setting the Level of System Information in Log Files | 51

Map metadata to a display value

([Link])
For calculation and tax area lookup requests, this parameter enables the mapping of metadata
to a display value that is written to the log. The value of the parameter specifies the name of
each HTTP header to log, as well as the name to give to that header when it is logged. You can
specify multiple headers by separating each pair with a comma.
The supported metadata source is HTTP headers.
The supported logger types include:
• multipartition
• vertex
• log4j
• slf4j
The parameter is in this format:
[Link]={X-Trace-Id="CorrelationId", X-Forwarded-For="ClientIp"}
There is no default value for this parameter.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
Chapter 3. Parameters That You’ll Need to Set
Up Your O Series Instance
This chapter describes the parameters that you may need to set up O Series. These parameters
fall into the following categories:
• Database connection parameters
• System security parameters, including password-related parameters
• Federated security parameters
• Data Management parameters
• Web Service parameters
• Simple Mail Transfer Protocol (SMTP) parameters

In this chapter
Database connection parameters................................................ 52
[Link] ........................................................ 60
O Series Security parameters ...................................................... 60
Federated security parameters ................................................... 69
Data Management parameters ................................................... 86
Web Service Parameters ............................................................. 96
Simple Mail Transfer Protocol (SMTP) ......................................... 99

Database connection parameters

The parameters that are described in this section relate to the setup of the databases that O
Series uses to calculate tax and store the results of those calculations.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 53

O Series database connections

([Link].logical_database_name)

This parameter setting enables you to define Vertex O Series database connections using alias
connections or JBDC datasources.
The Vertex O Series installation program initially sets connections for the Vertex O Series
databases. Use this parameter to:
• Define database connection strings. These parameter settings enable you to define Vertex
database connections by using alias connections or JBDC data sources. The Vertex O Series
installation program initially sets up connections for the five Vertex O Series databases.
• Identify multiple Tax Journals when you have more than one Calculation Engine. If you have
more than one Calculation Engine, you need to identify the Tax Journal that each one uses.
The Tax Journal that is associated with the Vertex O Series user interface uses
[Link].JOURNAL_DB.main with the precedence indicator precedence=0
appended to it.
Each subsequent Tax Journal reference has a unique suffix appended to the Tax Journal
name and a precedence indicator that increments by one. For example, the second Tax
Journal is identified with this parameter: [Link].JOURNAL_DB.alt1 with a
precedence=1. Additional Tax Journals (N) are identified with this parameter:
[Link].JOURNAL_DB.alt1+N with a precedence=1+N.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 54

• Change user ID and passwords when you copy Vertex O Series databases to a new
environment (clone your databases). Because cloning Vertex O Series databases provides an
exact Vertex O Series database copy, the exact same database users and passwords will be
available initially. If there is a need to change the users and/or passwords, then update the
[Link] file to change the users and passwords for the connection strings to the five
Vertex O Series databases.
Use this parameter for:
• Alias connections
• JDBC datasource connections
• Multiple Calculation engines
• Multiple Reporting databases
The parameter is in this format:
[Link].logical_database_name= DB Name
There is no default value.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 55

Alias connections
The [Link].logical_database_name parameter enables you to define Vertex O
Series database connections using alias connections.
This table explains the components of the URL for an alias connection:
Connection information Description
url Indicates the beginning of connection parameters that identify the database for
the JDBC driver.
host name Identifies the physical location of the host computer.
port number Identifies the port that the database uses.
Database name Identifies the database name.

This table explains the connection parameters for an alias connection:

Connection Parameter Description
user Unencrypted user name to be used for the connection.
euser Encrypted user name to be used for the connection. This overrides any
unencrypted user name that was specified.
password Unencrypted password to be used for the connection.
epassword Encrypted password to be used for the connection. This overrides any
unencrypted password that was specified.
pooling This setting enables you to disable O Series JDBC connection pooling. The default
value is true.
maxConnnections Maximum number of connections that can exist at any given time. If you have
reached the maximum number of connections, additional requests for connections
are blocked until an existing connection becomes available. If you do not supply
this value, the system sizes the connection pool so that each connection is
successful.
The value for this parameter is scalable to suit the unique needs of your
environment.
maxBlockTime Maximum number of seconds that a connection request is blocked while waiting
for an existing connection to become available. The default maximum block time is
30 seconds.
Description An optional identifier that describes the version of multiple Reporting databases.
The value of this field displays in the Data Source drop-down list on the Extract
Definition page when you add a Custom Reports - VRA data extract.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 56

Examples of alias connections

This example shows the parameters that define five O Series database connections by using
alias connections:
[Link].JOURNAL_DB={url="jdbc:oracle:thin:@tpsor[Link]orcl",euser="f7Y2d
Cm3mGt+4D",epassword="f7Y2dCm3mGt+4D", pooling="true",maxConnections="25",
maxBlockTime="30"}
[Link].RPT_DB={url="jdbc:oracle:thin:@tpsor[Link]orcl",euser="f7Y2dCm3m
Gt+4D",epassword="f7Y2dCm3mGt+4D", maxConnections="25", pooling="true",
maxBlockTime="30", description="Current 9.x Reporting Database"}
[Link].RPT_DB.PRIOR_RELEASE1={url="jdbc:oracle:thin:@tpsor[Link]orcl",e
user="f7Y2dCm3mGt+4D",epassword="f7Y2dCm3mGt+4D", maxConnections="25", pooling="true",
maxBlockTime="30", description="8.x Reporting Database"}
[Link].RPT_DB.PRIOR_RELEASE2={url="jdbc:oracle:thin:@tpsor[Link]orcl",e
user="f7Y2dCm3mGt+4D",epassword="f7Y2dCm3mGt+4D", pooling="true", maxConnections="25",
maxBlockTime="30", description="7.x Reporting Database"}
[Link].TAXGIS_DB={url="jdbc:oracle:thin:@tpsor[Link]orcl",euser="f7Y2dC
m3mGt+4D",epassword="f7Y2dCm3mGt+4D", pooling="true", maxConnections="25",
maxBlockTime="30"}
[Link].TPS_DB={url="jdbc:oracle:thin:@tpsor[Link]orcl",euser="f7Y2dCm3m
Gt+4D",epassword="f7Y2dCm3mGt+4D", pooling="true", maxConnections="25",
maxBlockTime="30"}
[Link].UTIL_DB={url="jdbc:oracle:thin:@tpsor[Link]orcl",euser="f7Y2dCm3
mGt+4D", epassword="f7Y2dCm3mGt+4D", pooling="true", maxConnections="25",
maxBlockTime="30"}

Define the JDBC driver ([Link].x)

This parameter setting defines the JDBC driver to be used for all database queries.
If multiple drivers are required, the parameter must be followed by a period and an integer
indicating the preferred load order, as illustrated in this example, which loads the Oracle driver
and the JTDS driver for Microsoft SQL Server:
[Link].1=[Link]
[Link].2=[Link]
Typically, only a single driver needs to be loaded.
Default = none

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 57

Setting the managed database connection pool cleanup service interval

([Link])

This parameter defines the time interval for a Vertex O Series service to monitor the Vertex O
Series managed database connection pool for each Vertex O Series database. The default value
is -1, which indicates that the connection pool cleanup service is inactive.
If this parameter is set to a number greater than zero, the service periodically monitors each
Vertex O Series managed connection pool and closes idle connections. The parameter is
specified in minutes.
This service executes for each Vertex O Series WAR application. Setting this parameter to a low
value in a busy Vertex O Series instance may impact the system performance. Vertex
recommends that to start you set this parameter to 15 minutes and gradually fine tune the
timing as needed in your environment. You must restart Tomcat if you modify this parameter.
Note: Do not set this parameter if you use a JNDI data source to manage all Vertex O Series
database connections.
Example:
To set the service interval to 15 minutes, set the parameter as follows:
[Link]=15

Vertex recommends using this parameter to manage the maximum number of Oracle database
connections.
Default = -1

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 58

Setting the managed database connection pool maximum idle time

([Link])

This parameter defines the time in minutes that Vertex O Series managed connections in Vertex
O Series managed database connection pools in each Vertex O Series database can remain idle,
before being identified as candidates for closure. This parameter works only if the
[Link] parameter is set to a number greater than zero.
Setting this parameter to a low value in a busy Vertex O Series instance may impact the system
performance. Connections will be closed and created frequently, leading to connection creation
overhead time. Tune this parameter value depending on:
• The number of Vertex O Series deployments sharing a database
• The total number of Vertex O Series database connections allowed for all Vertex O Series
deployments
You must restart Tomcat if you modify this parameter.
Example:
To set the maximum idle time to 15 minutes, set the parameter seen below:
[Link]=15

Vertex recommends using this parameter to manage the maximum number of Oracle database
connections.
Default = 10

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 59

Setting the number of managed database connection pool maximum idle

connections ([Link])

This parameter defines the number of maximum idle connections that can remain idle in a
Vertex O Series managed database connection pool for each Vertex O Series database. This
parameter works only if the [Link] parameter is set to
a number greater than zero.
This parameter works in conjunction with the [Link] parameter.
For example:
The [Link] parameter value is 15, identifying 15 idle
connections for closure. This [Link] value is 10.
Five idle connections are closed, leaving 10 idle connections in the pool.
Setting this parameter to a low value in a busy Vertex O Series instance may impact the system
performance. Connections will be closed and created frequently, leading to connection creation
overhead time. Tune this parameter value depending on:
• The number of Vertex O Series deployments sharing a database
• The total number of Vertex O Series database connections allowed for all Vertex O Series
deployments
You must restart Tomcat if you modify this parameter.
Example:
To set the maximum number of idle connections to 5, set this parameter as follows:
[Link]=5

Vertex recommends using this parameter to manage the maximum number of Oracle database
connections.
Default = 10

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 60

[Link]
This parameter defines the list of services for which a life cycle is to be managed by the servlet
(or other application controllers).
Note that each name in the Vertex configuration file must be unique, and each service must be
specified in the Vertex configuration file. If multiple services are started, the parameter must be
followed by a period and an integer indicating the preferred startup order. Shutdown is always
in the opposite order from startup.
This example illustrates the parameters used to start two services:
[Link].1=[Link].Service1
[Link].2=[Link].Service2
The startup sequence is Service1 and then Service2. The shutdown sequence is Service2 and
then Service1.
The default setting below enables Preferences:
[Link].10=[Link]
pService
Default = none

O Series Security parameters

The passwords in this section enable you to set various aspects of the passwords that are used
to log in to O Series. You can define the minimum length of user passwords between 6 - 16
characters for new passwords. You can also have the system check that the password contains
at least one alphabetic and one numeric character.
Edit the [Link] (see page 64) parameter to define password length.
Edit the [Link] (see page 61) parameter to have the
system check the validity of the character types.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 61

Enable trusted login ([Link])

This parameter setting indicates whether trusted login is enabled.

Possible settings are true (enabled) and false (disabled).
Default = false
Note: This parameter applied to O Series 6.0 and 7.0 but is no longer needed for O Series 8.0
and 9.0.

Set the password to be alphanumeric

([Link])

This parameter setting defines whether or not the user password must be alphanumeric.
Set this parameter to true to indicate that the password must contain at least one alphabetic
character and one numeric character. Otherwise, the password can be any character
combination.
Note: This parameter applies only when you create new passwords.
Default = false

Set the password to require special characters

([Link])

This parameter setting defines whether or not the user password must include at least one
special character (!@#$%^&*).
Set this parameter to true to indicate that the password must contain at least one special
character. The default value of this parameter is false, which means that the password does
not need to contain any special characters.
Note: This parameter applies only when you create new passwords.
Default = false

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 62

Set the number of failed login attempts permitted

([Link])

This parameter setting enables you to adjust the limit on the number of failed login attempts
that you can have.
Valid values include:
• Any positive number. This number represents the login attempt that disables the user
account if the login is not successful.
• Zero or any negative number. Setting this parameter to a zero or a negative number allows
unlimited unsuccessful login attempts without disabling the user account.
Note: You must restart your application server after you set this parameter to make this
change effective.
Default = 3

Handling failed login attempts ([Link])

This parameter defines how O Series handles failed login attempts.

Possible settings are USER_LOCKOUT and IP_LOCKOUT.
When the parameter value is set to USER_LOCKOUT, the user's account is locked after the
maximum number of failed logins is reached within a 10-minute time span. A system
administrator must unlock the account.
When the parameter value is set to IP_LOCKOUT, the offending user account is not locked.
However, the offending IP address is barred from logging in after the maximum number of
attempts is reached. This IP address is unlocked after the lockout period is over.
Default = USER_LOCKOUT

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 63

IP address lockout period ([Link])

This parameter defines the number of minutes that Vertex O Series locks out an IP address after
a user unsuccessfully attempts access.
This parameter can be set only during initialization.
Default = 5

Password reset email subject ([Link])

This parameter defines the subject line that Vertex O Series uses when sending a password
reset email to the user.
This parameter can be set only during initialization.
Default = Security Alert for Your OSeries Account

Password reset email text ([Link])

This parameter defines the email content that Vertex O Series uses when sending a password
reset email to the user.
This parameter can be set only during initialization.
Default = You have received this message because Info@[Link] is listed as the recovery email
address for your Vertex O Series account. Your temporary password is <password>. Please use
this password to login to your account. You will be prompted to change your password when
you login.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 64

Permit reuse of passwords

([Link])

This parameter enables an administrator to prevent users from reusing previous passwords.
This parameter can be set to any integer between 0 and 24.
These are the results of setting this parameter:
• Setting this parameter to 1 prevents a user from reusing their most recent previous
password.
• Setting this parameter to a number between 2 and 24 prevents a user from reusing from 2
to 24 previous passwords.
• Setting this parameter to 0 turns the parameter off. No checking of password reuse is done.
The parameter is in this format:
[Link]=nn

where:
nn is the number of previous passwords that the user cannot reuse.
Default = 1

Set password minimum length ([Link])

This parameter setting defines the minimum length of the user password.
Set this parameter to indicate the minimum length of the password to between 6 and 16
characters.
Default = 6

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 65

Set the user name minimum length ([Link])

This parameter setting defines the minimum length of the user names.
Set this parameter to indicate the minimum length of user names between 1 and 16 characters.
Note: This parameter applies only when you create new user names.
Default = Enter an integer from 1 to 16.

Encrypted Proxy Password

This setting defines the value of the encrypted proxy password which, in conjunction with the
encrypted user name, is required to connect to the Internet via a proxy server.
Use this setting only if you want to encrypt the password that is used to connect through a
proxy server.
You can encrypt the password with the Vertex O Series encryption utility, which is run from the
command line in either Windows ([Link]) or UNIX ([Link]). The utility
is in the bin subdirectory where you have installed Vertex O Series.
Changes to the proxy password take effect after a full cache refresh. The cache refresh
frequency default is 5 minutes.
Note: This setting displays only for Master Administrators when the Scope option is set to
System.

There is no default value for this setting.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 66

Encrypted Proxy User

This setting defines the encrypted proxy user name that is required to connect to the Internet
via a proxy server.
Use this setting only if you want to encrypt the password that is used to connect through a
proxy server.
You can encrypt the user name with the Vertex O Series encryption utility, which is run from the
command line in either Windows ([Link]) or UNIX ([Link]). The utility
is in the bin subdirectory where you have installed Vertex O Series.
Changes to the proxy user name take effect after a full cache refresh. The cache refresh
frequency default is 5 minutes.
There is no default value for this setting.

Password Expiration (Days)

This preference indicates the maximum number of days before a user's password expires.
Valid values for this preference are numbers between 0 and 365. If the value of this preference
is 0, the password does not expire.
Default = 0

Max User Inactivity (Days)

This preference indicates the maximum number of days of inactivity before a Vertex O Series
user is disabled.
Valid values for this preference are numbers between 0 and 180. If the value of this preference
is 0, there is no limit on the number of days of user inactivity.
Default = 0

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 67

Proxy Host

This setting defines the value of the proxy host to be used when connecting to the Internet
through a proxy server.
This setting is usually set at the Java Virtual Machine (JVM) level or at the application-server
level but, if not previously set, can be set here.
The value of this setting can be either the domain name or the IP address of the proxy host.
Changes to the proxy host take effect after a full cache refresh. The cache refresh frequency
default is 5 minutes.
There is no default value for this setting.

Proxy Password

This setting defines the value of the proxy password which, in conjunction with the user name,
is required to connect to the Internet via a proxy server.
This setting is usually set at the Java Virtual Machine (JVM) level or at the application-server
level but, if not previously set, can be set here.
There is no default value for this setting.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 68

Proxy Port

This setting defines the port to be used when connecting to the Internet via a proxy server.
This setting is usually set at the Java Virtual Machine (JVM) level or at the application-server
level, but if not previously set, can be set here. Valid values for this setting are 0 and any
positive integer.
Changes to the proxy port take effect after a full cache refresh. The cache refresh frequency
default is 5 minutes.
There is no default value for this setting.

How the default value in the [Link] setting relates to [Link]

If you have set [Link], but did not set [Link], Java internally sets a default
value in [Link] to port 443.

Proxy User

This setting defines the proxy user name that is required to connect to the Internet via a proxy
server.
This setting is usually set at the Java Virtual Machine (JVM) level or at the application-server
level but, if not previously set, can be set here.
Changes to the proxy user name take effect after a full cache refresh. The cache refresh
frequency default is 5 minutes.
There is no default value for this setting.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 69

Federated security parameters

The parameters that are described in this section relate to setting up federated security. With
federated security, an Vertex O Series user authenticates once with an Identity Provider (IdP)
and the authentication is shared with Vertex, the Service Provider (SP). The IdP can be Vertex or
a third-party security authentication application, such as SAML 2.0 or OAuth 2.0. If you choose
Vertex O Series as your IdP, Vertex O Series serves as both the IdP and SP. If you use an external
IdP, O Series is the SP only.
Vertex O Series security requires additional configuration in the configuration file ([Link]),
whether you are using an internal or external IDP. Use the parameters in the Security
configuration (see page 69) section to configure Vertex O Series security.
If you are configuring an external IdP, you need to authorize Vertex O Series as a client and
allow mapping of external users to an internal Vertex O Series user. You need to do the
following:
• Modify the [Link] to establish IdP and authorization protocol (SAML 2.0 protocol or
OAuth 2.0 protocol).
• Configure O Series to work with your IdP provider.
• Select the security model on the parameter [Link] with one of
the following options:

Security model Authentication

(Default) DBASE Internal

SSO External OAuth
SAML External SAML

Set the properties in the following sections to configure O Series to work with an external IdP:
• OAuth 2.0 integration properties (see page 72)
• SAML 2.0 integration properties (see page 77)

Security configuration
This section describes the parameters for configuring federated security to use either an
internal or external IdP.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 70

Internal Oauth client ID (oauth.client_id)

This parameter setting defines the client_id for OAuth token validation.
Default = oseries-service

Client secret for Vertex in the OAuth configuration (oauth.client_secret)

This parameter defines the client password for OAuth token validation.
Specify the client secret for Vertex in the internal OAuth configuration.
This parameter supports bcrypt 2a encryption. The default password is encrypted in the
[Link] file for new installations. Determine if you want to encrypt the client secret for
existing installations.
Vertex recommends encrypting the oauth.client_secret in the [Link] file using an encryption
tool that supports bcrypt 2a encryption.
A sample tool can be found at [Link]
([Link]
Caution: The client secret is sensitive information and must remain confidential.

Set how long in seconds the token is valid ([Link].access_token_validity)

This parameter setting defines, in seconds, how long the token is valid.
Default = 64800

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 71

Define the web page to which users are redirected

(oauth.web_server_redirect_uri)

This optional parameter setting defines the web page to which users are redirected after they
authenticate.
You need to use this parameter to authorize additional redirect locations when these conditions
apply:
• You will be using a custom user interface.
• You have special routing requirements.
You can define multiple UI locations with a comma separated list.
If no locations are defined, users are directed to the Vertex O Series user interface.

Signing key that O Series uses to sign the access token ([Link])

This parameter setting defines a key that Vertex O Series uses to sign the access token.
This value is a unique character string that is shared among Vertex O Series internal applications
for signing and validating tokens. Vertex recommends that you change this value from the
default and use a key that is, at a minimum, 32 characters long.
Default = 123

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 72

Post-logout redirect URIs (oidc.post_logout_redirect_uris)

You can add the optional configuration parameter oidc.post_logout_redirect_uris to the

[Link] file to, when no post_logout_redirect_uri query string is provided, redirect users to
a specified URL after a successful logout.
The parameter's value entries consist of a list of valid URLs separated by commas. For example:
oidc.post_logout_redirect_uris=[Link]
[Link] [Link]
Values must be valid URLs.
When the oidc.post_logout_redirect_uris configuration parameter does not exist in the
[Link] file or has no values specified, the default redirect URL is
[Link]

When the oidc.post_logout_redirect_uris configuration parameter does exist and is not

empty, the following occurs:
• When the post_logout_redirect_uri query string is not provided, the first URL in the
oidc.post_logout_redirect_uris configuration parameter is used.

• When the post_logout_redirect_uri query string is provided and a matching URL is found in
the oidc.post_logout_redirect_uris configuration parameter, the matching URL is used.
• When the post_logout_redirect_uri query string is provided but no matching URL is found,
the first URL in the list is used.

OAuth 2.0 integration properties

The properties that are described in this section apply if your external IdP is OAuth, and you
have set the value of the [Link] parameter to OAUTH.
Note: Provider1 is a variable that represents a registration ID for your authentication provider.

Unique client ID for O Series in an external IdP configuration

([Link]-id)

When setting up the registration, this parameter setting specifies a unique client ID for Vertex O
Series in an external IdP configuration.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 73

Client secret for Vertex in the external IdP configuration

([Link]-secret)

This parameter setting specifies the client secret for Vertex in the external IdP configuration.
A secret is used by the OAuth client to authenticate to the authorization server.

Client name for the external IdP

([Link]-name)

When setting up the registration, this parameter setting specifies the client name for the
external IdP.

Limit access granted to an access token

([Link])

This parameter setting limits the amount of access that is granted to an access token.
For example, an access token that is issued to a client application may be granted READ and
WRITE access to protected resources, or only READ access.

Registration ID for the authentication provider

([Link].provider1)

This parameter setting is the registration ID for the authentication provider.

Note: This value is the same as the
[Link]-name value.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 74

Authentication scheme that the IdP uses to authenticate

([Link]-authentication-scheme
)

This parameter setting defines the authentication scheme that the IdP uses to authenticate the
client's credentials.
Note: Vertex O Series supports only basic authentication.
Valid values are:

Parameter value Authentication scheme

basic Use basic authentication.

form Post credentials in the body of the request.
query Add credentials as query parameters in the URL.

Note: The value provider1 is a variable that represents a registration ID for your authentication
provider.

Authorization grant to the client to obtain an access token

([Link]-grant-type)

This parameter setting defines an authorization grant, which is a credential representing the
resource owner's authorization to the client, that is used by the client to obtain an access token.
There are four standard grant types:
• Authorization code (default)
• Implicit
• Resource owner password credentials
• Client credentials

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 75

Authorized redirect URI for O Series

([Link]-uri-template)

This parameter setting specifies the authorized redirect URI for Vertex O Series.
[Link]

URI to which O Series redirects to authenticate the user

([Link]-uri)

When setting up the registration that Vertex O Series requires to communicate with the
provider, this parameter setting specifies the URI to which Vertex O Series redirects to
authenticate the user.

Token - for future use ([Link]-uri)

This parameter setting for a token is for future use.

User-info - for future use

([Link]-info-uri)

This parameter setting for user information is for future use.

Authentication scheme that the IdP uses to authenticate

([Link]-info-authentication-method
)

This parameter setting defines the authentication scheme that the IdP uses to authenticate the
client's credentials.
Note: Vertex O Series supports only basic authentication.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 76

User identifier associated with access tokens

([Link]-name-attribute)

This parameter setting defines a user identifier to be associated with access tokens, which are
obtained by the client that is using the client credentials.
Note: This parameter is not available when using an OpenID _security provider for federated
security. For OpenID providers, Vertex O Series uses the "sub" claim for username.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 77

SAML 2.0 integration properties

The properties that are described in this section apply if your external IdP is SAML, and you have
set the value of the [Link] parameter to SAML.
If your external IdP is SAML, and you have set the value of the
[Link] parameter to SAML, review and configure the following
parameters:
[Link]
Defines the location of the metadata.
Use one of the following prefixes in your location:
• file: for an absolute file location
• http: for a URL
• classpath: for a file location that is relative to the classpath
Default = classpath://[Link]
[Link]
Specifies whether the metadata requires a signature.
Default = false
[Link]
Contains the service provider's (Vertex O Series) entity ID.
Example: urn:test:oseries:berwyn
There is no default value.
[Link]
Specifies whether to force a user to reauthenticate on each request.
Default = false
[Link]
(Optional) Defines which assertion attribute O Series uses for the user name. If no attribute is
defined, O Series uses the NameID attribute.
Default = NameID

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 78

[Link]
Defines the maximum refresh interval, in milliseconds, for the SAML metadata interval. This
parameter can be set only during initialization.
Default = 360000
[Link]
Defines the minimum refresh interval, in milliseconds, for the SAML metadata interval. This
parameter can be set only during initialization.
Default = 60000
[Link]
Defines the real number, between 0.0 and 1.0, that Spring applies to the initial refresh time to
determine the next refresh time.
Default = 0.75
[Link]
Defines the base URL from which SAML endpoints are constructed. The value must be a URL
with a protocol, a server, a port, and a context path.
Example: [Link]
This parameter can be set only during initialization.
If you are running Vertex O Series behind a load balancer, you need to set
[Link] to override the default value that the O Series metadata
generator creates. This override enables the IdP to successfully contact the SP via the load
balancer.
Default = [Link]
[Link]
Defines the location of the keystore certificate file. SAML uses this file to verify the assertion
signature.
This parameter value can be a URL, an absolute file location, or a file location that is relative to
the classpath.
Default = classpath://[Link]
[Link]
Contains the keystore password.
Default = vertex

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 79

[Link]
Contains the keystore alias name.
Default = oseries

Location of the metadata ([Link])

This parameter defines the location of the IdP's XML metadata information.
It can be a URL, an absolute file location, or a file location that is relative to the classpath. Prefix
the location with either url:, file:, or classpath:, respectively.
The parameter is in this format:
[Link]=<location type>:<path>

where:
<location type> is a URL, file, or classpath
<path> is the location of the IdP's metadata information
For example:

Location type Example

URL [Link]=
url:[Link]

Absolute file location [Link]=

fil[Link]//vertex/9.0/oseries/[Link]

File location that is [Link]=classpath://[Link]

relative to the
classpath

Default = classpath://[Link]

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 80

Require a signature for metadata ([Link])

This parameter specifies whether the IdP's XML metadata requires a signature.
The parameter is in this format:
[Link]=<value>

where:
<value> is true or false
Default = false

Entity ID of the service provider (O Series) ([Link])

This parameter contains the entity ID of the service provider (Vertex O Series).
The parameter is in this format:
[Link]=<value>

where:
<value> is the service provider's entity ID
The value depends on your SAML provider and should be in the form of a Uniform Resource
Name as follows:
urn:<platform>:<provider>:<location>

For example:
urn:test:oseries:Berwyn

There is no default value.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 81

Force a user to reauthenticate ([Link])

This parameter specifies whether or not to force a user to reauthenticate on each request.
The parameter is in this format:
[Link]=<value>

where:
<value> is true or false
Default = false
Note: This parameter can be set only during initialization.

User name ([Link])

This is an optional parameter that defines which assertion attribute Vertex O Series uses for the
user's user name.
If no attribute is defined, Vertex O Series uses the NameID attribute.
The parameter is in this format:
[Link]=<value>

where:
<value> is the assertion attribute to be used for the user name
Default = NameID

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 82

Maximum SAML Metadata Refresh Delay ([Link])

This parameter defines the maximum refresh interval, in milliseconds, for the SAML metadata
interval.
The parameter is in this format:
[Link]=<value>

where:
<value> is the number, in milliseconds, that defines the maximum refresh interval
Default = 360000
Note: This parameter can be set only during initialization.

Minimum SAML Metadata Refresh Delay ([Link])

This parameter defines the minimum refresh interval, in milliseconds, for the SAML metadata
interval.
The parameter is in this format:
[Link]=<value>

where:
<value> is the number, in milliseconds, that defines the minimum refresh interval
Default = 60000
Note: This parameter can be set only during initialization.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 83

SAML Metadata Refresh Delay Factor ([Link])

This parameter defines the real number, between 0.0 and 1.0, that Spring applies to the initial
refresh time to determine the next refresh time.
Choose an appropriate number to ensure that a refresh occurs before the metadata's
expiration. Attempts to refresh metadata begin around the product of this number and the
maximum refresh delay (see page 82).
The parameter is in this format:
[Link]=<value>

where:
<value> is the number by which the maximum refresh delay time is multiplied to determine
the next refresh time
Default = 0.75
Note: This parameter can be set only during initialization.

SAML Metadata Entity Base URL ([Link])

This parameter defines the base URL from which SAML endpoints are constructed.
The value must be a URL with a protocol, a server, a port, and a context path.
The parameter is in this format:
[Link]=<value>

where:
<value> is the base URL including protocol, a server, a port, and a context path
Default = [Link]
Notes:
• This parameter can be set only during initialization.
• If you are running Vertex O Series behind a load balancer, you need to set
[Link] to override the default value that the O Series metadata
generator creates. This override enables the IdP to successfully contact the SP via the load
balancer.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 84

SAML keystore file location ([Link])

This parameter setting defines the location of the SAML keystore certificate file.
SAML uses this file to verify the assertion signature. The parameter value can be a URL, an
absolute file location, or a file location that is relative to the classpath.
The parameter is in this format:
[Link]=<type>:<path>

where:
type is the type of link
path is the location path of the file
For example:

Type of link Example

URL [Link]=url:[Link]
/[Link]

Absolute file location [Link]=fil[Link]//vertex/9.0/oseries/

[Link]

File location that is [Link]=classpath://[Link]

relative to the
classpath

Default = classpath://[Link]

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 85

SAML keystore password ([Link])

This parameter setting contains the SAML keystore password.

The parameter is in this format:
[Link]=<value>

where:
value is the password
For example:
[Link]=vertex

Default = vertex

SAML keystore alias name ([Link])

This parameter setting contains the SAML keystore alias name.

The parameter is in this format:
[Link]=<value>

where:
value is the name of the keystore alias

For example:
[Link]=oseries

Default = oseries

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 86

Data Management parameters

Use these parameters to define the content, file location, and performance of Data
Management activities. These activities include the following:
• Purging the Reporting database
• Exporting the Tax Journal to the Reporting database
• Purging the Tax Journal
• Performing a Returns Export
• Importing tax data
• Exporting tax data
• Performing a data update
• Setting entity limits

Define the root directory ([Link])

This parameter defines the Vertex Home directory that contains the Data Update files.
Default= dataupdate

Set how long before old update records are purged

([Link])

This parameter setting enables you to define the maximum number of hours for which old
update records remain in the database before purging.
Vertex recommends that you set this value to at least 12 hours.
Default=48

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 87

Disabling a Cache Refresh ([Link])

This parameter setting enables you to disable default cache refreshes for the server.
Set this parameter during startup.
You must restart your application server after you set this parameter to make this change
effective.
Default=false

Override the default location for your files

([Link])

This parameter setting enables you to choose a directory location for your files, overriding the
<VertexRoot>\data standard location.

The parameter is in this format:

[Link]=\\\\<directory>\\data

where:
<directory> is the alternative location for your files.
Example: [Link]=\\\\myshare\\data
Note: Make sure that the terminal directory in the data directory's location path is named data
in all lowercase letters. Otherwise, your results files will not write to the directory or
display on the O Series user interface.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 88

Tax Journal Export email ([Link])

This parameter setting generates and sends an email notification to a designated administrator
when a Tax Journal Export to the Reporting database fails.
If you are an administrator and want to be notified by email when a Tax Journal Export to the
Reporting database fails, set this this parameter:
[Link]=email address
where:
email address is the full email address of the designated administrator.

Note: Set this parameter in tandem with [Link]

and [Link].
Default = none

Retail Tax Extract email

([Link])

This parameter setting generates and sends an email notification to a designated administrator
when a Retail Tax Extract fails.
If you are an administrator and want to be notified by email when a Retail Tax Extract fails, set
this parameter:
[Link]=email address

where:
email address is the full email address of the designated administrator.

Note: Set this parameter in tandem with [Link] and

[Link].
Default = none

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 89

DPP Transactions Exempt

This setting specifies whether a direct pay permit that was applied to a transaction is reported
as exempt after the Returns Export process completes.
Valid values are true and false. When the check box is selected, the value is true. When the
check box is cleared, the value is false.
Choose your setting:
• Set the value to true to write a direct pay permit transaction amount to the Tax Journal as
exempt.
• Set the value to false to write a direct pay permit transaction to the Tax Journal as $0 for
the taxable, nontaxable, exempt, and tax amounts.
If you report direct pay permit transactions as exempt, you can assign a Reason Type of Direct
Pay Permit for certain jurisdictions when entering the permits in Vertex O Series.
Default = false

Specify the subject line in email sent when Tax Journal Export fails
([Link])

This parameter setting generates and sends an email message to a designated administrator
when a Tax Journal Export to the Reporting database fails.
If you are an administrator and want to be notified by an email with a detailed message when a
Tax Journal Export to the Reporting database fails, set this parameter:
[Link]=email subject
where:
email subject is the subject line of the email message to be sent to the designated
administrator.
Note: Set this parameter in tandem with [Link] and
[Link].
Default = Vertex - Journal to Reporting

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 90

Specify the subject line in email sent when Retail Tax Extract fails
([Link])

This parameter setting generates and sends an email message to a designated administrator
when a Retail Tax Extract fails.
If you are an administrator and want to be notified by an email with a detailed message when a
Retail Tax Extract fails, set this parameter:
[Link]=email subject
where:
email subject is the subject line of the email message to be sent to the designated
administrator.
Note: Set this parameter in tandem with [Link] and
[Link].
Default = Retail Tax Extract failed. Check the logs for details.

Data Management base directory ([Link])

This parameter setting defines the base directory for Data Management activities.
Default = VertexRoot/data

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 91

Specify the text of email sent when Tax Journal Export fails
([Link])

This parameter setting generates and sends an email message to a designated administrator
when a Tax Journal Export to the Reporting database fails.
If you are an administrator and want to be notified by an email with a detailed message when a
Tax Journal Export to the Reporting database fails, set this parameter:
[Link]=email message
where:
email message is the detailed email message text to be sent to the designated
administrator.
Note: Set this parameter in tandem with [Link] (see
page 88) and [Link] (see page 89).
Default = Journal to Reporting failed. Please view the log files under VERTEXROOT\\\\logs
directory.

Specify the text of email sent when Retail Tax Extract fails
([Link])

This parameter setting generates and sends an email message to a designated administrator
when a Retail Tax Extract fails.
If you are an administrator and want to be notified by an email with a detailed message when a
Retail Tax Extract fails, set this parameter:
[Link]=email message
where:
email message is the detailed email message text to be sent to the designated
administrator.
Note: Set this parameter in tandem with [Link] and
[Link].
Default = Retail Tax Extract failed. Check the logs for details.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 92

Base directory for data movement manifest files

([Link])

This parameter setting defines the base directory for Data Management manifest files.
Default = VertexRoot/data/manifest

Define the number of rows purged ([Link])

This parameter setting defines the number of rows that were purged from the Reporting
database line item table.
Default = 10000

Customer Limit

This setting specifies the maximum number of customer records that can exist in an O Series
partition. This setting can be configured for all partitions by the Master Administrator and for an
individual partition by the Partition System Administrator. In both cases, the limit affects the
maximum number of records within a single partition.
If a user or an import process attempts to add and save a record that causes the record count to
exceed this limit, an error message notifies you that the limit is reached. For Tax Data Import
tasks, a Task Log message notifies you that the limit is reached and identifies the blocked
records.
Records that are not included in the record count are:
• Deleted records that were created and end dated on the same day
• Records that are end dated before the new record's start date
There is no default value for this setting. When no value is specified for this limit, an unlimited
number of records is permitted, subject to the constraints of the database framework.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 93

Exemption Certificate Limit

This setting specifies the maximum number of exemption certificate records that can exist in an
O Series partition. This setting can be configured for all partitions by the Master Administrator
and for an individual partition by the Partition System Administrator. In both cases, the limit
affects the maximum number of records within a single partition.
If a user or an import process attempts to add and save a record that causes the record count to
exceed this limit, an error message notifies you that the limit is reached. For Tax Data Import
tasks, a Task Log message notifies you that the limit is reached and identifies the blocked
records.
Records that are not included in the record count are:
• Deleted records that were created and end dated on the same day
• Records that are end dated before the new record's start date
There is no default value for this setting. When no value is specified for this limit, an unlimited
number of records is permitted, subject to the constraints of the database framework.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 94

Taxability Driver Limit

This setting specifies the maximum number of taxability driver records that can exist in an O
Series partition. The record count includes taxability drivers, user-defined commodity codes,
and user-defined communications service codes. This setting can be configured for all partitions
by the Master Administrator and for an individual partition by the Partition System
Administrator. In both cases, the limit affects the maximum number of customer records within
a single partition.
If a user or an import process attempts to add and save a record that causes the record count to
exceed this limit, an error message notifies you that the limit is reached. For Tax Data Import
tasks, a Task Log message notifies you that the limit is reached and identifies the blocked
records.
Records that are not included in the record count are:
• Deleted records that were created and end dated on the same day
• Records that are end dated before the new record's start date
There is no default value for this setting. When no value is specified for this limit, an unlimited
number of records is permitted, subject to the constraints of the database framework.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 95

Taxability Mapping Limit

This setting specifies the maximum number of taxability mapping records that can exist in an O
Series partition. This setting can be configured for all partitions by the Master Administrator and
for an individual partition by the Partition System Administrator. In both cases, the limit affects
the maximum number of records within a single partition.
If a user or an import process attempts to add and save a record that causes the record count to
exceed this limit, an error message notifies you that the limit is reached. For Tax Data Import
tasks, a Task Log message notifies you that the limit is reached and identifies the blocked
records.
Records that are not included in the record count are:
• Deleted records that were created and end dated on the same day
• Records that are end dated before the new record's start date
There is no default value for this setting. When no value is specified for this limit, an unlimited
number of records is permitted, subject to the constraints of the database framework.

Taxpayer Limit

This setting specifies the maximum number of taxpayer records that can exist in an O Series
partition. This setting can be configured for all partitions by the Master Administrator and for an
individual partition by the Partition System Administrator. In both cases, the limit affects the
maximum number of records within a single partition.
If a user or an import process attempts to add and save a record that causes the record count to
exceed this limit, an error message notifies you that the limit is reached. For Tax Data Import
tasks, a Task Log message notifies you that the limit is reached and identifies the blocked
records.
Records that are not included in the record count are:
• Deleted records that were created and end dated on the same day
• Records that are end dated before the new record's start date
There is no default value for this setting. When no value is specified for this limit, an unlimited
number of records is permitted, subject to the constraints of the database framework.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 96

Vendor Limit

This setting specifies the maximum number of vendor records that can exist in an O Series
partition. This setting can be configured for all partitions by the Master Administrator and for an
individual partition by the Partition System Administrator. In both cases, the limit affects the
maximum number of records within a single partition.
If a user or an import process attempts to add and save a record that causes the record count to
exceed this limit, an error message notifies you that the limit is reached. For Tax Data Import
tasks, a Task Log message notifies you that the limit is reached and identifies the blocked
records.
Records that are not included in the record count are:
• Deleted records that were created and end dated on the same day
• Records that are end dated before the new record's start date
There is no default value for this setting. When no value is specified for this limit, an unlimited
number of records is permitted, subject to the constraints of the database framework.

Web Service Parameters

Web Service-related parameters enable you to define how O Series interacts with XML
messages.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 97

Define the Vertex schema locations

([Link])

This parameter setting defines the location of the Vertex XML schemas.
Note that the value must be constructed as follows:
namespace space schema location
For example:
urn:vertexinc:o-series:tps:2:0 2.0/VertexEnvelope_vertex.xsd
All schema location entries are linked together to form a single composite value. If the schema
location is a relative path, Vertex Home/schema is used as a prefix.
If multiple locations are specified, append the parameter with a period (.) and an integer
indicating the preferred load order, as in this example:
[Link].1=urn:vertexinc:o-series:tps:2:0
2.0/VertexEnvelope_vertex.xsd
[Link].2=urn:vertexinc:o-series:tps:2:1
2.1/VertexEnvelope_vertex.xsd
[Link].3=urn:vertexinc:o-series:tps:2:2
2.2/VertexEnvelope_vertex.xsd
[Link].4=[Link] vertex_license.xsd
[Link].5=[Link] vertex_sqlexp.xsd
[Link].6=[Link] vertex_etl.xsd
Default = none

Enable Schema Validation

This setting indicates whether schema validation is enabled for incoming XML messages.
If you want to validate your XML messages, the schema location in the XML files must match the
location in which the Vertex XML schema is deployed. The XML schemas are installed with
Vertex O Series.
Schema validation affects performance and should be disabled in most production
environments. However, during integration or other testing, schema validation can be useful in
determining the root cause of errors.
Possible settings are true (to enable) and false (to disable). When the check box is selected, the
value is true. When the check box is cleared, the value is false.
Default = false

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 98

Return Detailed Tax Calculation Timings

This setting returns additional timing metrics in XML (SOAP) and JSON (REST) responses to
service calls for tax calculation and tax area lookup to assist in troubleshooting performance
issues.
This setting can be set at the system level or at the partition level. When set to true at the
system level, the setting is on for all partitions. When set to false at the system level, the
setting can be set to true at the partition level to override the system setting for that partition.
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = false

Installed web applications

The [Link] parameter contains a list of Vertex O Series 9.0 web applications that are
currently installed. While usually written to the [Link] file during installation, depending on
when your instance of Vertex O Series 9.0 was installed, it may not have been. If the
[Link] parameter is not in the [Link] file, all available web applications are
installed.
An example of the [Link] entry in the [Link] file may look like this:
[Link]=O Series UI,O Series Calculation Services,O Series Configuration
Services,Exemption Certificate Portal

There is no default value.

With the release of Vertex O Series 9.0 SR10, a new web application - O Series Configuration
API - was added. You may need to modify the [Link] parameter before patching to
Vertex O Series 9.0 SR10 if you want to use the O Series Configuration API web application.
See "Deploy the O Series Configuration API before applying 9.0 SR10" in the Release Notes for
instructions on how to make sure that the O Series Configuration API web application is
installed.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 99

Simple Mail Transfer Protocol (SMTP)

Simple Mail Transfer Protocol (SMTP) is a standard Internet protocol for sending email
messages. SMTP identifies the message format and transfer agent that stores and forwards the
mail. You must set [Link] (see page 100) in [Link]
to enable SMTP for email messages pertaining to certificates and Data Movement notifications.
Depending on the unique security requirements defined by your IT department, you may,
optionally, set the following parameters:
• [Link] (see page 99)
• [Link] (see page 101)
• [Link] (see page 100)
Refer to the Configuration Parameters Reference Guide for details.

SMTP Security Requirements

([Link])

This parameter setting defines SMTP security requirements for sending email pertaining to
certificates.
Simple Mail Transfer Protocol (SMTP) is a standard Internet protocol for sending email
messages. SMTP identifies the message format and transfer agent that stores and forwards the
mail.
Valid values are true and false.
Example:
To enable SMTP authentication, set this parameter:
[Link]=true

If you set this parameter to true, you must also set the
[Link] and
[Link] parameters.

Default = none

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 100

SMTP Host Name ([Link])

This parameter setting defines the SMTP host name for sending email pertaining to certificates.
Simple Mail Transfer Protocol (SMTP) is a standard Internet protocol for sending email
messages. SMTP identifies the message format and transfer agent that stores and forwards the
mail.
You must set this parameter to enable the email functionality pertaining to certificates in Vertex
O Series.
Example:
To identify the SMTP host name, set this parameter:
[Link]=[Link]

Default = none

SMTP password ([Link])

This parameter setting defines the SMTP password for a given user for sending email pertaining
to certificates.
Simple Mail Transfer Protocol (SMTP) is a standard Internet protocol for sending email
messages. SMTP identifies the message format and transfer agent that stores and forwards the
mail.
Example:
To identify the SMTP password for a given user name, set this parameter:
[Link]=UserIDPassword

where:
UserIDPassword is the email password that is associated with a specific user. For
example, the user Bob Jones, who has the email user name BJones, may have an
associated email password of BJonesPassword.
Default = none

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 3. Parameters That You’ll Need to Set Up Your O Series Instance | 101

SMTP user name ([Link])

This parameter setting defines the SMTP user name for sending email pertaining to certificates.
Simple Mail Transfer Protocol (SMTP) is a standard Internet protocol for sending email
messages. SMTP identifies the message format and transfer agent that stores and forwards the
mail.
Example:
To identify the SMTP user name, set this parameter:
[Link]=UserID

where:
UserID is the email user identifier that is associated with a specific user. For example,
the user Bob Jones may have the email user name BJones.
Default = none

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
Chapter 4. Calculation Engine Parameters
Calculation Engine-related parameters enable you to define how to use specific aspects of the
Calculation Engine.

In this chapter
How the Calculation Engine handles multi-currency calculations104
How standard invoice verification processing works..................105
Taxability Precedence - Sales......................................................108
Taxability Precedence - Procurement .........................................112
Adjust the penny difference on tax ............................................119
Accrue Assisted Line Items as Independent Line Items ..............121
Allow Fair Market Value and Extended Price to have different signs ....
Calculate Lowest Total Tax .........................................................122
Disable Gross Receipts Tax Imposition Type Inclusion Rules in
Alabama .....................................................................................123
Hawaii jurisdiction level rounding
([Link].hawaii_jurisdiction_level_rounding) .............124
Include Basis Inclusions in Nontaxable Basis ..............................124
Return No Tax elements for primary impositions .......................125
Return No Tax elements with Output Notices or Invoice Text Codes ....
Return the Material Origin Code ................................................127
Rounding - Group By Tax Rate ....................................................127
Include Response Time ...............................................................128
Skip Transaction Row .................................................................128
Allow Empty Unit of Measure ....................................................129
Do Not Show NoTax Results .......................................................129
Max Trials ...................................................................................130
A delete request deletes all transactions with the same transaction
ID - OS.........................................................................................131
Force Distribute Tax on Failure - Supplies ..................................131
Force Distribute Tax on Failure - Procurement ...........................132
Transaction Dump ......................................................................134
Single Jurisdiction VAT Tax Inclusive Optimized Path .................134
Group Positive and Negative Line Items Together .....................135
Include Services in Apportionment ............................................136
Include Charged Tax in Allocated Line Item ................................136
Exclude Tax Areas With Unregistered Jurisdictions ....................137
Fail Transaction If Registration Id Invalid ....................................138
Imply Main Division Registration with Tax Registration Overrides139

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 4. Calculation Engine Parameters | 103

Limit Tax Inclusive To Extended Price .........................................140

Tax Include Round Up Tax ..........................................................140
Push Tax Assist Location To Transaction Level ...........................141

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 4. Calculation Engine Parameters | 104

How the Calculation Engine handles

multi-currency calculations
If your organization does business internationally, you need to handle multiple types of
currency. The Calculation Engine compares the currency type for the transaction against the
currency type for filing currency. The filing currency is the currency of the country for which tax
is due.
When the filing currency is different from the transaction currency, the Calculation Engine uses
the currency conversion rate for the situs location and multiplies this rate by the transaction
currency amount. The following situs location conditions determine how the Calculation Engine
completes multi-currency processing:
• If both the currency unit and currency rate are specified at the situs location, the Calculation
Engine calculates filing currency values successfully. The calculated tax is returned in the
converted transaction currency amount for a given country.
• If neither the currency unit or currency rate is specified at the situs location, the Calculation
Engine calculates successfully but no filing currency values are calculated.
• If either the currency unit or currency rate is specified at the situs location, the Calculation
Engine does not calculate successfully.

What about multi-currency in different business events?

If you have multi-currency in Supplies or Procurement transactions, be certain that you have
passed the conversion rate and currency code to ensure that the system can complete the
calculation.
If you do not pass the conversion rate or currency rate to O Series, the system posts a 0.00
amount in the filing currency field.

What should I do to ensure that the system calculates filing currency for Supplies or
Procurement transactions?
Run the Transaction Detail Report in Custom Reports - VRA to transaction extended amount to
the filing currency amount. These numbers should match. For more details on Custom Reports -
VRA, refer to the O Series Help.
If the filing currency amount is 0 and the transaction extended amount not 0, the system may
have passed incomplete data for the calculation. In this case, you must handle these
transactions manually for reporting purposes.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 4. Calculation Engine Parameters | 105

How standard invoice verification processing

works
Invoice verification processing refers to how the Calculation Engine evaluates the transaction in
progress to determine whether it meets the threshold setting that is defined in My Enterprise.
The Calculation Engine uses the verification threshold as a calculation criteria to determine how
to continue processing the transaction.
A verification threshold is a percentage and/or amount set on the taxpayer and vendor level.
The Calculation Engine compares the difference between the vendor-charged tax amount and
the Vertex-calculated tax amount against the verification threshold. The results of this
comparison determine how the Calculation Engine completes its processing.
Vendor registration information refines the precision of invoice verification.

What does the Calculation Engine evaluate during invoice verification

processing?
During invoice verification processing, the Calculation Engine determines whether or not the
vendor is registered to collect tax, based on four criteria:
• Vendor registrations included in the Invoice Verification request
• Charged Tax amount included in the Invoice Verification request
• Vendor registrations set up in My Enterprise
• The Assume Vendor Registration for Invoice Verification setting in System > Administration >
Settings

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 4. Calculation Engine Parameters | 106

How the Calculation Engine processes vendor registration information

If you supplied any vendor registration information within the transaction itself or in My
Enterprise, the Calculation Engine determines whether to calculate a vendor tax, based on those
registrations. If the registrations are appropriate, the Calculation Engine calculates a vendor tax.
If you did not supply vendor registration information within the transaction itself or in My
Enterprise, but the Charged Tax amount on the Invoice Verification request is greater than zero,
the Calculation Engine assumes a vendor registration and calculates vendor tax appropriately.
If the Charged Tax amount on the Invoice Verification request is zero, the Calculation Engine (by
default) assumes the vendor is not registered to collect tax. Otherwise, this transaction would
fail when the Calculation Engine evaluates the invoice verification threshold on Invoice
transactions with no tax.

How to override Calculation Engine processing when Charged Tax

amount is zero
If you want to know what the vendor tax amount would be if a vendor were registered, you can
override Calculation Engine processing by setting Assume Vendor Registration for Invoice
Verification to true in System > Administration > Settings. The Calculation Engine processes the
transaction as if the vendor was registered.

Assume Vendor Registration for Invoice Verification

This setting controls the system logic for invoice verification in Procurement transactions.
Use this as the global setting for invoice verification. Valid values are true and false. When the
check box is selected, the value is true. When the check box is cleared, the value is false.
Choose your setting as follows:
• Set the value to true so that the Calculation Engine always assumes that the vendor is
registered and calculates vendor tax and the variance, even if there are no registrations for a
given vendor and the charged tax amount equals zero.
Set this parameter to true during the initial configuration of the O Series web service.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 4. Calculation Engine Parameters | 107

• Set the value to false so that the Calculation Engine does not assume that the vendor is
registered, but uses available data during transaction processing to determine registration.
To limit the setting to a specific country:
1. Click the + icon. The Override Information dialog box displays.
2. In the Child Name field, enter an ISO ALPHA three-country code, such as USA for United
States or CAN for Canada.
3. Click ADD.
4. Click SAVE.
Default = false

Recommendations for threshold verification outside of Vertex O Series

If you want to perform threshold verification outside of O Series, ensure that the vendor’s
actual registration is assumed. Registration impacts the tax conclusion on where the tax is
collected and by whom. To ensure that the Calculation Engine assumes that vendors in the
United States and Canada are registered for Consumer Use Tax transactions, set the value to
true.

If you set the value to true, the Calculation Engine always calculates tax and enables the
Enterprise Resource Planning (ERP) or financial system to leverage variances.

Recommendations for threshold verification within Vertex O Series

If you want to perform threshold verification within O Series, ensure that the vendor’s actual
registration is considered and not assumed. Registration impacts the tax conclusion on where
the tax is collected and by whom. To ensure that the Calculation Engine performs standard
invoice verification processing for Supplies and Procurement transactions, use the default value
of false for this setting. The false value directs the Calculation Engine to look up actual
registrations during invoice processing.

Recommendations for threshold verification within Vertex O Series in the United

States and Canada
If you want to perform threshold verification worldwide, you may need to handle these
transactions differently in the United States and Canada.
To limit the setting to a specific country:
1. Click the + icon. The Override Information dialog box displays.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 4. Calculation Engine Parameters | 108

2. In the Child Name field, enter an ISO ALPHA three-country code, such as USA for United
States or CAN for Canada.
3. Click ADD.
4. Click SAVE.
The Calculation Engine can then consistently process Supplies and Procurement transactions
worldwide, but uniquely handle transactions in the United States and Canada.

Recommendations for threshold verification set through an ERP or financial

system
For ERP or financial systems that perform their own processing logic for threshold checking,
make sure that no verification thresholds are set through My Enterprise in O Series.
Consequently, invoice verification always passes in O Series.

Taxability Precedence - Sales

These settings enable you to change the taxability precedence for Customers that the
Calculation Engine uses in Sales Tax, Lease Tax, or Value Added Tax.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 4. Calculation Engine Parameters | 109

Requirements for using taxability precedence settings

Caution: Before you make any changes to taxability precedence, contact Vertex Product
Support to address any questions that you might have.
Review the following requirements before you change taxability precedence:
• Vertex recommends that taxability precedence be modified during initial system
configuration only. If you change the precedence settings beyond initial system
configuration, there may be inconsistent tax calculation results between transactions in the
Tax Journal and associated credit transactions until the next system heartbeat.
• If you change one setting within a specific financial event, you must change the remaining
settings that apply to that financial event. Each setting that is associated with a specific
financial event must have a unique value.
• Any change to the taxability precedence applies consistently across all steps of a tax
calculation. Discuss these implications with your tax professional.
• Input fields are considered in the order of their relative precedence value. A lower value
number is evaluated before a higher value number. For example, to enable all other input
fields to take precedence over the Taxpayer field, thereby enabling Taxpayer mappings and
rules to represent default taxability, set the appropriate Taxpayer configuration value to a
number that is larger than any other value within the group of settings for that tax type. The
largest valid setting value is 9999.
Caution: The taxability precedence for all input fields that have a code and a class is critical
to the calculation process. The code field must always have a higher precedence
than its corresponding class. Do not set the precedence for the class input field
higher, that is, with a lower value, than the code input field. Otherwise, you can get
unexpected calculation results.

Sales - Commodity Code Processing Order

This setting enables you to change the taxability precedence for Commodity Code that the
Calculation Engine uses in Sales Tax, Lease Tax, or Value Added Tax supplies transactions.
You can change the default taxability precedence by using this setting in conjunction with the
other settings that apply to a specific financial event.
Default = 600

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 4. Calculation Engine Parameters | 110

Sales - Customer Class Processing Order

This setting enables you to change the taxability precedence for Customer Class that the
Calculation Engine uses in Sales Tax, Lease Tax, or Value Added Tax supplies transactions.
You can change the default taxability precedence by using this setting in conjunction with the
other settings that apply to a specific financial event.
Caution: The Customer input field must always have a higher precedence than the Customer
Class input field. Do not set the precedence for Customer Class to be higher – that
is, with a lower value – than the precedence for Customer.
Default = 200

Sales - Customer Processing Order

This setting enables you to change the taxability precedence for Customer that the Calculation
Engine uses in Sales Tax, Lease Tax, or Value Added Tax supplies transactions.
You can change the default taxability precedence by using this setting in conjunction with the
other settings that apply to a specific financial event.
Caution: The Customer input field must always have a higher precedence than the Customer
Class input field. Do not set the precedence for Customer Class to be higher – that
is, with a lower value – than the precedence for Customer.
Default = 100

Sales - Flexible Fields Processing Order

This setting enables you to change the taxability precedence for Flexible Fields that the
Calculation Engine uses in Sales Tax, Lease Tax, or Value Added Tax supplies transactions.
You can change the default taxability precedence by using this setting in conjunction with the
other settings that apply to a specific financial event.
Default = 900

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 4. Calculation Engine Parameters | 111

Sales - Material Origin Processing Order

This setting enables you to change the taxability precedence for Material Origin that the
Calculation Engine uses in Sales Tax, Lease Tax, or Value Added Tax supplies transactions.
You can change the default taxability precedence by using this setting in conjunction with the
other settings that apply to a specific financial event.
Default = 1000

Sales - Product Class Processing Order

This setting enables you to change the taxability precedence for Product Class that the
Calculation Engine uses in Sales Tax, Lease Tax, or Value Added Tax supplies transactions.
You can change the default taxability precedence by using this setting in conjunction with the
other settings that apply to a specific financial event.
Caution: The Product input field must always have a higher precedence than the Product
Class input field. Do not set the precedence for the Product Class input field higher,
that is, with a lower value, than the Product input field. If you do, you may get
unexpected calculation results.
Default = 500

Sales - Product Processing Order

This setting enables you to change the taxability precedence for Product that the Calculation
Engine uses in Sales Tax, Lease Tax, or Value Added Tax supplies transactions.
You can change the default taxability precedence by using this setting in conjunction with the
other settings that apply to a specific financial event.
Caution: The Product input field must always have a higher precedence than the Product
Class input field. Do not set the precedence for the Product Class input field higher,
that is, with a lower value, than the Product input field. If you do, you may get
unexpected calculation results.
Default = 400

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 4. Calculation Engine Parameters | 112

Sales - Taxpayer Processing Order

This setting enables you to change the taxability precedence for Taxpayer that the Calculation
Engine uses in Sales Tax, Lease Tax, or Value Added Tax supplies transactions.
You can change the default taxability precedence by using this setting in conjunction with the
other settings that apply to a specific financial event.
Default = 300

Sales - Usage Class Processing Order

This setting enables you to change the taxability precedence for Usage Class that the Calculation
Engine uses in Sales Tax, Lease Tax, or Value Added Tax supplies transactions.
You can change the default taxability precedence by using this setting in conjunction with the
other settings that apply to a specific financial event.
Default = 800

Sales - Usage Processing Order

This setting enables you to change the taxability precedence for Usage that the Calculation
Engine uses in Sales Tax, Lease Tax, or Value Added Tax supplies transactions.
You can change the default taxability precedence by using this setting in conjunction with the
other settings that apply to a specific financial event.
Default = 700

Taxability Precedence - Procurement

These settings enable you to change the taxability precedence for Commodity Codes that the
Calculation Engine uses in Consumer Use Tax and Value Added Tax.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 4. Calculation Engine Parameters | 113

Procurement - Commodity Code Processing Order

This setting enables you to change the taxability precedence for Commodity Code that the
Calculation Engine uses in Consumer Use Tax and Value Added Tax purchases transactions.
You can change the default taxability precedence by using this setting in conjunction with the
other settings that apply to a specific financial event.
Default = 500

Procurement - Cost Center Processing Order

This setting enables you to change the taxability precedence for Cost Center that the Calculation
Engine uses in Consumer Use Tax and Value Added Tax purchases transactions.
You can change the default taxability precedence by using this setting in conjunction with the
other settings that apply to a specific financial event.
Default = 900

Procurement - Department Code Processing Order

This setting enables you to change the taxability precedence for Department Code that the
Calculation Engine uses in Consumer Use Tax and Value Added Tax purchases transactions.
You can change the default taxability precedence by using this setting in conjunction with the
other settings that apply to a specific financial event.
Default = 1000

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 4. Calculation Engine Parameters | 114

Procurement - Flexible Fields Processing Order

This setting enables you to change the taxability precedence for Flexible Fields that the
Calculation Engine uses in Consumer Use Tax and Value Added Tax purchases transactions.
You can change the default taxability precedence by using this setting in conjunction with the
other settings that apply to a specific financial event.
Note: This setting treats the precedence of flexible fields as a group relative to other settings
for a transaction. The relative precedence of individual flexible fields is defined by their
assigned sequence numbers.
Default = 1500

Procurement - General Ledger Account Processing Order

This setting enables you to change the taxability precedence for General Ledger Account that
the Calculation Engine uses in Consumer Use Tax and Value Added Tax purchases transactions.
You can change the default taxability precedence by using this setting in conjunction with the
other settings that apply to a specific financial event.
Default = 1100

Procurement - Material Code Processing Order

This setting enables you to change the taxability precedence for Material Code that the
Calculation Engine uses in Consumer Use Tax and Value Added Tax purchases transactions.
You can change the default taxability precedence by using this setting in conjunction with the
other settings that apply to a specific financial event.
Default = 1200

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 4. Calculation Engine Parameters | 115

Procurement - Material Origin Processing Order

This setting enables you to change the taxability precedence for Material Origin that the
Calculation Engine uses in Consumer Use Tax and Value Added Tax purchases transactions.
You can change the default taxability precedence by using this setting in conjunction with the
other settings that apply to a specific financial event.
Default = 1600

Procurement - Project Number Processing Order

This setting enables you to change the taxability precedence for Project Number that the
Calculation Engine uses in Consumer Use Tax and Value Added Tax purchases transactions.
You can change the default taxability precedence by using this setting in conjunction with the
other settings that apply to a specific financial event.
Default = 1300

Procurement - Purchase Class Processing Order

This setting enables you to change the taxability precedence for Purchase Class that the
Calculation Engine uses in Consumer Use Tax and Value Added Tax purchases transactions.
You can change the default taxability precedence by using this setting in conjunction with the
other settings that apply to a specific financial event.
Caution: The Purchase input field must always have a higher precedence than the Purchase
Class input field. Do not set the precedence for the Purchase Class input field
higher, that is, with a lower value, than the Purchase input field. If you do, you may
get unexpected calculation results.
Default = 400

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 4. Calculation Engine Parameters | 116

Procurement - Purchase Processing Order

This setting enables you to change the taxability precedence for Purchase that the Calculation
Engine uses in Consumer Use Tax and Value Added Tax purchases transactions.
You can change the default taxability precedence by using this setting in conjunction with the
other settings that apply to a specific financial event.
Caution: The Purchase input field must always have a higher precedence than the Purchase
Class input field. Do not set the precedence for the Purchase Class input field
higher, that is, with a lower value, than the Purchase input field. If you do, you may
get unexpected calculation results.
Default = 300

Procurement - Taxpayer Processing Order

This setting enables you to change the taxability precedence for Taxpayer that the Calculation
Engine uses in Consumer Use Tax and Value Added Tax purchases transactions.
You can change the default taxability precedence by using this setting in conjunction with the
other settings that apply to a specific financial event.
Default = 600

Procurement - Usage Class Processing Order

This setting enables you to change the taxability precedence for Usage Class that the Calculation
Engine uses in Consumer Use Tax and Value Added Tax purchases transactions.
You can change the default taxability precedence by using this setting in conjunction with the
other settings that apply to a specific financial event.
Caution: The Usage input field must always have a higher precedence than the Usage Class
input field. Do not set the precedence for the Usage Class input field higher, that is,
with a lower value, than the Usage input field. If you do, you can get unexpected
calculation results.
Default = 200

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 4. Calculation Engine Parameters | 117

Procurement - Usage Processing Order

This setting enables you to change the taxability precedence for Usage that the Calculation
Engine uses in Consumer Use Tax and Value Added Tax purchases transactions.
You can change the default taxability precedence by using this setting in conjunction with the
other settings that apply to a specific financial event.
Caution: The Usage input field must always have a higher precedence than the Usage Class
input field. Do not set the precedence for the Usage Class input field higher, that is,
with a lower value, than the Usage input field. If you do, you can get unexpected
calculation results.
Default = 100

Procurement - Vendor Class Processing Order

This setting enables you to change the taxability precedence for Vendor Class that the
Calculation Engine uses in Consumer Use Tax and Value Added Tax purchases transactions.
You can change the default taxability precedence by using this setting in conjunction with the
other settings that apply to a specific financial event.
Caution: The Vendor input field must always have a higher precedence than the Vendor
Class input field. Do not set the precedence for the Vendor Class input field higher,
that is, with a lower value, than the Vendor input field. If you do, you can get
unexpected calculation results.
Default = 800

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 4. Calculation Engine Parameters | 118

Procurement - Vendor Processing Order

This setting enables you to change the taxability precedence for Vendor that the Calculation
Engine uses in Consumer Use Tax and Value Added Tax purchases transactions.
You can change the default taxability precedence by using this setting in conjunction with the
other settings that apply to a specific financial event.
Caution: The Vendor input field must always have a higher precedence than the Vendor
Class input field. Do not set the precedence for the Vendor Class input field higher,
that is, with a lower value, than the Vendor input field. If you do, you may get
unexpected calculation results.
Default = 700

Procurement - Vendor SKU Processing Order

This setting enables you to change the taxability precedence for Vendor SKU that the
Calculation Engine uses in Consumer Use Tax and Value Added Tax purchases transactions.
You can change the default taxability precedence by using this setting in conjunction with the
other settings that apply to a specific financial event.
Default = 1400

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 4. Calculation Engine Parameters | 119

Adjust the penny difference on tax

This setting enables you to turn off the automatic rounding adjustment that is made when
calculating tax-inclusive transactions. Examples of transactions that may include tax in the
transaction amount are business-to-business transactions in the United States and transactions
involving value added tax (VAT).
Possible values are true (to enable) and false (to disable). When the check box is selected, the
value is true. When the check box is cleared, the value is false. When the check box is selected,
the automatic rounding adjustment occurs. When the check box is cleared, the rounding
adjustment is not made.
For Brazil transactions, it may be important to turn off this parameter to get appropriate tax
amounts for the Nota Fiscal to pass SEFAZ validation. The following example shows how tax
amounts differ for a line item in a Brazil transaction when this parameter is turned on and when
it is turned off. In this example, the tax-inclusive transaction involves the following criteria:
• NCM code is 8544.42.00
• Material Origin is 1 for Foreign, Direct Import
• Buyer is End Consumer Individual
• Seller is located in Sao Paulo
• Buyer is located in Rio de Janeiro
• Line item extended amount is R$197.10, which is tax inclusive

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 4. Calculation Engine Parameters | 120

Imposition Effective rate Rounding adjustment applies No rounding adjustment

Subtotal amount = R$142.74 Subtotal Amount = R$142.75

Taxable Calculated tax Taxable Calculated tax

amount amount
IPI 0.05 187.70 9.39 187.71 9.39
COFINS 0.076 187.70 14.27 187.71 14.27
PIS 0.0165 187.70 3.10 187.71 3.10
ICMS 0.04 197.09 7.88 197.10 7.88
Differential ICMS - SP 0.00 137.96 0.00 137.97 0.00
Differential ICMS - RJ 0.122886 137.96 16.95 137.97 16.95
FECOP 0.02 137.96 2.77 137.97 2.76

Note that the difference in calculated tax occurs with FECOP. This is because O Series allocates
the centavo difference to the imposition for which there is the least difference between the
rounded amount and the unrounded amount for the calculated tax – in this case, it is FECOP.
To edit this setting, you must be assigned a Master Administrator role or a role with similar
permissions.
Default = true

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 4. Calculation Engine Parameters | 121

Accrue Assisted Line Items as Independent Line

Items
For accrual processing of transactions with child line items that are created by an allocation, this
setting provides you with two options:
• Set the value to false to process the accrual by grouping all allocated line items according to
jurisdiction type and then adjusting the taxes based on the order of the jurisdiction type.
This order is country, main division, subdivision, city, and district. The sum of the
vendor-charged tax plus the child line-item accrual amounts cannot exceed the total
calculated tax for the line item.
• Set the value to true to calculate the child line-item accrual amounts independently of the
line-item expected accrual amount. The sum of the vendor-charged tax plus the child
line-item accrual amounts can exceed the total calculated tax for the line item.
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = false

Allow Fair Market Value and Extended Price to

have different signs
When set to true, the Calculation Engine allows the fair market value and extended price to
have different signs, such as -100 and 100. For example: if the value of a returned item is
recorded as a negative amount, but you need to show the fair market value of the item as a
positive amount, you can set the value of this setting to true.
When set to false, the Calculation Engine raises an error if the fair market value and extended
price have different signs.
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = false

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 4. Calculation Engine Parameters | 122

Calculate Lowest Total Tax

This setting indicates whether tax for a transaction is calculated at the highest possible tax or
the lowest possible tax.
Possible settings are true (to return lowest possible tax) or false (to return the highest possible
tax).
If the value is set to true while using the default TaxGIS settings, the lowest of the returned tax
areas is selected for TaxResults. If you are entering City Tax Areas with Calculate Lowest Total
Tax set to true, you need to set Filter Postal Unincorporated Area to true. This prevents County
Tax Areas from being chosen for a tax calculation while you are passing information down to the
city level.
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = false

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 4. Calculation Engine Parameters | 123

Disable Gross Receipts Tax Imposition Type

Inclusion Rules in Alabama
This setting enables you to disable inclusion rules specific to the gross receipts imposition type
in Alabama during the calculation process. Vertex O Series executes all other applicable rules.
When selected, the setting applies to all jurisdictions within the state of Alabama. The setting is
not applicable to any gross receipts tax imposition types outside of Alabama.
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

When you change the value to true:

• Inclusion rules associated with the Rental Tax are excluded from the transaction.
• The Rental Tax is not part of the tax base.
• The additional tax is not calculated and not passed to your lessee.
Default = false

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 4. Calculation Engine Parameters | 124

Hawaii jurisdiction level rounding

([Link].hawaii_jurisdiction_level_rou
nding)
Tax laws in Hawaii specify an optimum tax rate that can be imposed for the Hawaii state-level
General Excise and Use Tax (GET). If a tax calculation uses the round up method, the optimum
tax rate may be exceeded when calculating tax for a transaction.
When set to true, this parameter uses the round off method that truncates an amount to two
decimal places when used in conjunction with the Hawaii Optimum Rate taxability category. For
example, Vertex O Series rounds the optimum tax rate of 4.166 percent to 4.16 percent before
calculating tax. This prevents a rate of 4.167 percent from being imposed, which may happen if
tax amounts are rounded up during tax calculation.
Valid values are true and false.
Default = false

Include Basis Inclusions in Nontaxable Basis

For nontaxable items, this setting provides the option to include basis inclusions in the
nontaxable basis amounts.
Valid values are true and false. When the check box is selected, the value is true. When the
check box is cleared, the value is false.
Choose your setting as follows:
• Set the value to true so that the system includes basis inclusions in nontaxable basis
amounts.
• Set the value to false so that the system does not include basis inclusions in nontaxable
basis amounts.
Default = false

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 4. Calculation Engine Parameters | 125

Return No Tax elements for primary impositions

When enabled, this setting returns a No Tax result in the XML response when that result applies
to a primary tax imposition. A primary imposition is the main tax imposition in a jurisdiction, and
it is typically the general sales and use tax imposition or the value added tax imposition for the
jurisdiction. The Partition System Administrator can enable this setting for a partition.
This setting is useful when both of the conditions below exist, but you want to include No Tax
results for primary impositions in XML responses:
• Impositions for which a taxpayer is not registered are deselected for certain jurisdictions and
are therefore typically suppressed in tax calculation.
• The Do Not Show NoTax Results setting is enabled to suppress No Tax results in the XML
response.
The Return No Tax elements for primary impositions setting overrides the Do Not Show NoTax
Results setting to allow No Tax results for primary impositions.

A related setting is Return No Tax elements with Output Notices or Invoice Text Codes.
When the check box is selected, No Tax elements are returned in the XML response. When the
check box is deselected, No Tax elements are not returned in the XML response.
Default = deselected

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 4. Calculation Engine Parameters | 126

Return No Tax elements with Output Notices or

Invoice Text Codes
When enabled, this setting returns a No Tax result in the XML response when that result
includes an output notice or an invoice text code. The Partition System Administrator can
enable this setting for a partition.
This setting is useful when both of the conditions below exist, but you want to include No Tax
results in XML responses when the results include an output notice or an invoice text code:
• Impositions for which a taxpayer is not registered are deselected for certain jurisdictions and
are therefore typically suppressed in tax calculation.
• The Do Not Show NoTax Results setting is enabled to suppress No Tax results in the XML
response.
The Return No Tax elements with Output Notices or Invoice Text Codes setting overrides the Do
Not Show NoTax Results setting to allow No Tax results for items with output notices and
invoice text codes.
A related setting is Return No Tax elements for primary impositions.
When the check box is selected, No Tax elements are returned in the XML response. When the
check box is deselected, No Tax elements are not returned in the XML response.
Default = deselected

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 4. Calculation Engine Parameters | 127

Return the Material Origin Code

When set to true, the original material origin code that was present before Tax Assist rule
processing is passed in the response XML and is posted to the Tax Journal.
For example:
If a Tax Assist rule replaces the original material origin, 7, with a different material origin,
10, then setting this parameter to true causes the original material origin, 7, to be
returned in the response XML and posted to the Tax Journal.
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Note: This setting displays only for Master Administrators when the Scope option is set to
System.

Default = false

Rounding - Group By Tax Rate

This setting enables you to group invoice line items by tax rate for rounding purposes.
Within each group of line items, Vertex O Series makes adjustments to minimize the total
rounding error of the group. When the check box is selected, the value is true. When the check
box is cleared, the value is false.
Making this setting true is useful for line item rounding when there are many line items with
many different tax dates. When this setting is false, Vertex O Series groups invoice line items by
tax date.
Default = false

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 4. Calculation Engine Parameters | 128

Include Response Time

This setting enables you to include the elapsed time for a calculation request in an XML
response.
Valid values are true and false. When the check box is selected, the value is true. When the
check box is cleared, the value is false.
Choose your setting as follows:
• Set the value to true so that the elapsed time for the calculation request is included in the
XML response.
• Set the value to false so that the elapsed time for the calculation request is not included in
the XML response.
Default = true

Skip Transaction Row

This setting directs the Calculation Engine to not write separate transaction-level rows to the
Tax Journal during transaction processing.
Note: These transaction-level details are required if you use Modify Synchronization messages
to change transaction data after it has been initially posted to the Tax Journal. You can
set this setting only if you do not use Modify Synchronization messages.
Valid values are true and false. If you set the value to true, the Calculation Engine does not
write transaction-level data to the Tax Journal. When you omit this processing step, Vertex O
Series performance may improve. Otherwise, the default value (false) for this setting directs
Vertex O Series to write transaction-level data to the Tax Journal.
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = false

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 4. Calculation Engine Parameters | 129

Allow Empty Unit of Measure

This setting enables a null value for the unit of measure to be passed through the Java API or
XML interface.
If this setting is disabled and a quantity-based rule is called, an error occurs.
Possible values are true (to enable) and false (to disable). When the check box is selected, the
value is true. When the check box is cleared, the value is false.
Default = false

Do Not Show NoTax Results

This setting enables you to specify whether or not NO_TAX records are included in transaction
results and are written to the Tax Journals.
Valid values are true and false:
• When set to true, NO_TAX records are not included in transactions and are not posted to the
Tax Journal.
• When set to false, NO_TAX records are included transactions and are posted to the Tax
Journal.
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = false

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 4. Calculation Engine Parameters | 130

Max Trials
This setting enables you to limit the number of tax calculations that Vertex O Series attempts
when addresses for a transaction have multiple tax areas.
When addresses for a transaction resolve to multiple tax areas, Vertex O Series calculates tax
for every combination of tax areas for all locations that are set for a transaction. The number of
combinations to be calculated could grow rapidly if you pass insufficient information for a
transaction, which results in decreased system performance.
Default = 1000

Best practices for using the Max Trials setting

Before you perform a Tax Area ID lookup, Vertex strongly recommends that you do the
following:
• Provide Tax Area IDs for the transaction instead of addresses. If this parameter is set too
low, O Series may not calculate some combinations of tax areas and locations.
• When performing Tax Area Lookup with an address, use the nine-digit ZIP+4 Code. The
five-digit ZIP Code is less precise and returns more Tax Area IDs. Each Tax Area ID must
determine the “best” (highest or lowest) tax result, based on your business rules.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 4. Calculation Engine Parameters | 131

A delete request deletes all transactions with

the same transaction ID - OS
This setting enables you to run a synchronization process when your Tax Journal database has
both active and deleted transactions with the same transaction identifier (transSyncIdCode).
Set this parameter to true or false as required:
• Set this parameter to true to allow a synchronization process when multiple transactions
with the same transaction identifier exist in your Tax Journal database, with one of the
transactions having an active status and the other transaction having a deleted status.
• Set this parameter to false after running the synchronization process.
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

If this setting is not enabled, and there are multiple transactions in the Tax Journal database
that have the same transaction identifier, then a delete request will fail.
Note: This setting displays only for Master Administrators when the Scope option is set to
System.

Default = false

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 4. Calculation Engine Parameters | 132

Force Distribute Tax on Failure - Supplies

This setting controls whether or not a Distribute Tax transaction is executed on an Input Total
Tax amount when the transaction is actually nontaxable.
This option enables you to use the tax amount that is written to the Tax Journal as the Input
Total Tax amount, regardless of the O Series tax calculation.
Choose your setting as follows:
• Set to true so that a Distribute Tax transaction is executed on a non-zero Input Total Tax
amount, even though the Calculation Engine determines that the transaction is nontaxable.
The Input Total Tax amount is distributed using the rates and rules for the appropriate
jurisdictions. The following warning message displays: Distribute Tax has been forced by
configuration option; thus, the tax calculation for the transaction identified by:
(U00000) may be wrong.

where:
U00000 is the transaction id
• Set to false so that the Distribute Tax transaction remains nontaxable.
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = false
Note: This feature can be enabled for Procurement transactions by using the Force Distribute
Tax on Failure - Procurement (see page 132) setting.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 4. Calculation Engine Parameters | 133

Force Distribute Tax on Failure - Procurement

This setting controls whether or not a Distribute Tax transaction is executed on an Input Total
Tax amount when the transaction is actually nontaxable.
This option enables you to use the tax amount that is written to the Tax Journal as the Input
Total Tax amount, regardless of the O Series tax calculation.
Choose your setting as follows:
• Set to true so that a Distribute Tax transaction is executed on a non-zero Input Total Tax
amount, even though the Calculation Engine determines that the transaction is nontaxable.
The Input Total Tax amount is distributed using the rates and rules for the appropriate
jurisdictions. The following warning message displays: Distribute Tax has been forced by
configuration option; thus, the tax calculation for the transaction identified by:
(U00000) may be wrong.

where:
U00000 is the transaction id
• Set to false so that the Distribute Tax transaction remains nontaxable.
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = false
Notes:
• This feature can be enabled for Supplies transactions by using the Force Distribute Tax on
Failure - Supplies (see page 131) setting.
• For a Distribute Tax request that has a non-zero Input Total Tax amount, but the Calculation
Engine determines either that the request is nontaxable or that the request is taxable but has
a tax result of $0.0, a configuration parameter can be set so that O Series proceeds to
distribute the Input Total Tax amount by using the rates and rules for the appropriate
jurisdictions.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 4. Calculation Engine Parameters | 134

Transaction Dump
This setting enables dumping of transactions in XML format to the log file ([Link])
before and after calling the calculateTax method.
Possible values are true (to enable) and false (to disable). After you enable this setting,
transaction dumping continues until you disable it. This setting is best used in a test or
development environment.
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = false

Single Jurisdiction VAT Tax Inclusive Optimized

Path
This setting enables you to use a simplified algorithm for tax-inclusive transactions as follows:
• When the value is set to true, the simplified algorithm is used for tax-inclusive transactions
(see below). This option is valid only for transactions in a single jurisdiction where the value
added tax is a single rate and there are no tiered taxes or bracket taxes. This option does not
apply to jurisdictions that have multiple value added tax rates, such as Brazil and Canada.
• When the value is set to false, the standard Vertex tax-inclusive calculation is used.
When the value is set to true, the Calculation Engine uses the following calculation process:
1. Use the following formula to calculate tax:
Tax Amount = Tax-Inclusive Amount * (Tax Rate / (1+ Tax Rate))
2. Use jurisdictional rounding rules to round the tax amount.
3. Use the following formula to calculate the basis amount:
Basis Amount = Tax-Inclusive Amount - Rounded Tax Amount
4. If the invoice has multiple line items, apply a smoothing process.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 4. Calculation Engine Parameters | 135

Note: If a Tax Assist rule applies line-item level rounding to the transaction by setting the
roundAtLineItemLevel field to true, smoothing is disabled.
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = true

Group Positive and Negative Line Items

Together
This setting enables you to group together line items with positive and negative amounts.
This is useful for Line Item Rounding and Apportionment.
Valid values are true and false.
Setting the value to true is useful for apportionment because it enables negative line item
amounts to be taxed the same as line items with positive amounts.
For Line Item Rounding, setting the value to true may produce individual line item taxes that
differ from the non-grouped results. However, the overall taxes paid or refunded to a
jurisdiction are the same.
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = false

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 4. Calculation Engine Parameters | 136

Include Services in Apportionment

This setting indicates whether or not Service Categories are included for apportionment.
Valid values are true and false. When the check box is selected, the value is true. When the
check box is cleared, the value is false.
When the value is set to true, Service Categories are included in tax apportionment. Set the
value to true when you want to use an apportioned tax rule other than freight where services
would apply. For example, set the value to true to apportion warranty charges.
When the value is set to false, Service Categories are not included in tax apportionment.
Default = false

Include Charged Tax in Allocated Line Item

When an allocation applies in a transaction, this setting enables you to use the total charged tax
of the parent line item plus the allocated line items when processing an accrual.
Choose your setting as follows:
• Set the value to false so that the Calculation Engine ignores the allocated line items'
charged tax when processing the accrual.
• Set the value to true so that the Calculation Engine uses the total charged tax to process the
accrual. The total charged tax is the sum of the parent line item charged tax plus its
allocated line items' charged tax.
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = true

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 4. Calculation Engine Parameters | 137

Exclude Tax Areas With Unregistered

Jurisdictions
When an address has more than one possible Tax Area ID, the Calculation Engine performs trial
calculations for each tax area to evaluate which one to use for the tax result.
This setting enables you to exclude some tax areas from evaluation, based on whether the seller
(for Supplies events) or vendor (for Procurement events) is not registered in one of the
applicable jurisdiction levels in the tax area.
When you set the value to true, the Calculation Engine excludes tax areas for a given location
from trial calculations when the following conditions apply:
• In Supplies transactions, the seller is not registered in at least one of the jurisdictions in the
tax area where registration is possible.
• In Procurement transactions, the vendor is not registered in at least one of the jurisdictions
in the tax area where registration is possible.
• The Tax Area Lookup has identified multiple tax areas for that unregistered jurisdiction and
at least one of the remaining tax areas does not include the unregistered jurisdiction.
The Calculation Engine ignores any unregistered jurisdiction that is common to all tax areas.
Possible values are true (to exclude tax areas from consideration during tax calculation) or false
(to include all tax areas during tax calculation).
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = false

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 4. Calculation Engine Parameters | 138

Fail Transaction If Registration Id Invalid

This setting defines whether or not a transaction fails due to an invalid registration ID in the
transaction response.
If the format validation of the registration ID returns an invalid result, the Calculation Engine
fails the transaction. This setting must be set to true for transactions with invalid registration
numbers to fail.
Valid values are true and false.
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = false

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 4. Calculation Engine Parameters | 139

Imply Main Division Registration with Tax

Registration Overrides
This setting directs the Calculation Engine to assume that all lower-level jurisdictions within a
given country-level registration are either registered or not registered.
Only country-level registrations are passed to Vertex O Series in the Tax Registration data
elements via XML messages. Set this setting to direct the processing path of the Calculation
Engine concerning these lower-level registrations.
Note: These registrations have no impact on registration setup and registration processing in
Vertex O Series.
Valid values are true and false.
• Set the value to true if you want the Calculation Engine to assume that all of the lower-level
jurisdictions within a given country-level registration are registered.
• Set the value to false if you want the Calculation Engine to assume that all of the
lower-level jurisdictions within a given country-level registration are not registered.
This parameter enables a suffix in the following format: XXX, where XXX is the ISO ALPHA-3
country code. For example, USA for United States and CAN for Canada.
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = false

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 4. Calculation Engine Parameters | 140

Limit Tax Inclusive To Extended Price

This setting enables you to reduce only the extended price of an item when a line item is
identified as tax inclusive.
If the value is set to true and a line item is identified as tax inclusive, the Calculation Engine uses
only the extended price basis amount (whether directly supplied or derived from the quantity
and unit price) as tax inclusive. Otherwise, the default value of false directs the Calculation
Engine to reduce all input basis amounts when processing a tax inclusive line item.
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = false

Tax Include Round Up Tax

This setting controls whether the Basis Amount is rounded up or down when the basis is derived
from a tax inclusive price.
Vertex O Series records the tax detail amount for tax inclusive calculations that require a detail
adjustment to arrive at the input inclusive price.
Valid values are true and false. Set the value to true to direct the Calculation Engine to round a
calculated tax result up.
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = false

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 4. Calculation Engine Parameters | 141

Push Tax Assist Location To Transaction Level

This setting enables you to set how a line-item location assigned via Tax Assist is applied.
Valid values are true and false:
• When set to true, the location is promoted to the transaction level and shared by all line
items.
• When set to false, the location is applied only to the line item that triggered the Tax Assist
rule.
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = true

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
Chapter 5. TaxGIS parameters
The Vertex® TaxGISTM database contains jurisdiction information that is updated monthly by
Vertex. Updates are applied using the O Series Data Update feature.
Edit these TaxGIS parameters to customize your Tax Area ID lookup to meet your needs. You
can also enable Vertex compression logic when standardizing a city name on an address during
a lookup.
Refer to Performance Tuning Parameters (see page 247) for recommendations for using TaxGIS
configuration parameters to get the best possible performance in jurisdiction lookups and Tax
Area ID lookups.

In this chapter
Alternative Region Type Lists .....................................................144
Approximate Tax Areas Historically ............................................147
Default Country Code For Address .............................................148
Filter Multi State Zip Codes ........................................................148
Filter Postal Area Given No Zip ...................................................149
Filter Postal Area Given Zip 5......................................................150
Filter Postal Area Given Zip 9......................................................151
Filter Postal County Area ............................................................152
Filter Postal Unincorporated Area ..............................................152
Match Prefix For Region Types ...................................................153
Maximum Full Addresses ...........................................................154
Maximum Tax Areas ...................................................................155
Minimum Aggregate Confidence ................................................156
Number Of Address Cleansing Lookup Attempts .......................156
Use Special Characters ...............................................................157
Retrieve Full Vertex Addresses ...................................................158
Override default Canada postal code setting
([Link]) ..................159
Required Region Types For Address ...........................................159
Retrieve Second Street Line in Address Cleansing ......................160
Retrieve Cleansed Address .........................................................163
To Preload All Tax Areas And Jurisdictions .................................164
Use Address Cleansing................................................................164
Use Vertex Compression Logic City ............................................165
Use Vertex Compression Logic Country ......................................166
Use Vertex Compression Logic Main Division .............................167
Use Vertex Compression Logic Sub Division ...............................168

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 5. TaxGIS parameters | 143

User Defined Address Mappings

([Link]).....169
Wait Time For Address Cleansing Retry ......................................174
Setting time before refreshing the user-defined address mappings
file
([Link]
elay) ............................................................................................175
TaxGIS Transaction Dump...........................................................175

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 5. TaxGIS parameters | 144

Alternative Region Type Lists

This setting defines a list of alternative lookup mechanisms by region types.
During a lookup, TaxGIS uses a list of region types to look up tax areas for the first lookup. If the
initial lookup does not find a match, then the system uses an alternative region type list. Each
alternative list contains region type XML tags, indicating that the lookup can use these fields of
the address for tax area lookup purposes. The following are possible region types:
• Country
Note: The Country region type must be an ISO country code. If your ERP passes in country
names, create a Tax Assist rule that converts the country names to the corresponding
two- or three- character ISO country codes.
• Main division
• Sub division
• City
• Postal Code
• ZIP5
• ZIP9
Note: The ZIP5 and ZIP9 region types are applicable only for the United States. They are ignored
for all other countries.
Each alternative is used in the order in which it is specified in the setting, until a valid tax area
list is found or until all the alternatives are exhausted.
To apply the setting to all countries, enter the alternative region types in the Setting Value field.
To limit the setting:
1. Click in the Setting Value cell and then click ADD. The Override Information dialog box
displays.
2. In the Child Name field, enter an ISO ALPHA three-country code, such as USA for United
States or CAN for Canada.
3. Click ADD.
4. In the Setting Value field of the newly created override setting, enter the alternative region
types.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 5. TaxGIS parameters | 145

5. Click SAVE.
The setting value can be in the following forms:
• rt1;rt2;rt3;rt4|rt3;rt4|rt2 to specify alternative region types

• NONE to turn this option off for a specific country

Examples
• To specify an alternative region type list that uses Main Division, City, and Postal Code as the
first lookup and Postal Code as the alternative lookup, type
MAIN_DIVISION;CITY;POSTAL_CODE|POSTAL_CODE in the field.

• To not use an alternative region type list, type NONE in the field.
There is no default value for this setting.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 5. TaxGIS parameters | 146

Alternative Region Type Lists (Calc Override)

This setting defines a list of alternative lookup mechanisms by region types to be used by the
Calculation Engine, overriding the Alternative Region Type Lists (see page 144) setting.
During a lookup, TaxGIS uses a list of region types to look up tax areas for the first lookup. If the
initial lookup does not find a match, then the system uses an alternative region type list. Each
alternative list contains region type XML tags, indicating that the lookup can use these fields of
the address for tax area lookup purposes. The following are possible region types:
• Country
Note: The Country region type must be an ISO country code. If your ERP passes in country
names, create a Tax Assist rule that converts the country names to the corresponding
two- or three- character ISO country codes.
• Main division
• Sub division
• City
• Postal Code
• ZIP5
• ZIP9
Note: The ZIP5 and ZIP9 region types are applicable only for the United States. They are ignored
for all other countries.
Each alternative is used in the order in which it is specified in the setting, until a valid tax area
list is found or until all the alternatives are exhausted.
To apply the setting to all countries, enter the alternative region types in the Setting Value field.
To limit the setting:
1. Click in the Setting Value cell and then click ADD. The Override Information dialog box
displays.
2. In the Child Name field, enter an ISO ALPHA three-country code, such as USA for United
States or CAN for Canada.
3. Click ADD.
4. In the Setting Value field of the newly created override setting, enter the alternative region
types.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 5. TaxGIS parameters | 147

5. Click SAVE.
The setting value can be in the following forms:
• rt1;rt2;rt3;rt4|rt3;rt4|rt2 to specify alternative region types

• NONE to turn this option off for a specific country

Examples
• To specify an alternative region type list that uses Main Division, City, and Postal Code as the
first lookup and Postal Code as the alternative lookup, type
MAIN_DIVISION;CITY;POSTAL_CODE|POSTAL_CODE in the field.

• To not use an alternative region type list, type NONE in the field.
Tax area lookups without tax calculation use the TaxGIS setting.
There is no default value for this setting.

Approximate Tax Areas Historically

This setting enables Vertex O Series to use the jurisdiction information in a new Tax Area ID to
approximate the tax areas that applied in the past.
Tax Area IDs are active based on their effective dates. When a new Tax Area ID is introduced, a
tax area lookup that uses the new Tax Area ID, performed before its effective date, fails.
If you set the value to true, Vertex O Series uses the jurisdiction information in the new tax area
to determine the appropriate tax area that would have applied in the past. In this example, the
message Successful lookup using approximate tax areas historically displays.
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = false

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 5. TaxGIS parameters | 148

Default Country Code For Address

This setting defines the default country code to use when a given address does not contain a
populated country field.
Vertex O Series uses ISO ALPHA-three country codes, such as USA for the United States and CAN
for Canada.
Default = USA

Filter Multi State Zip Codes

This setting enables you to activate or deactivate portions of ZIP Codes that cross state
boundaries.
When a Tax Area Lookup retrieves multiple tax areas and the value is set to true, Vertex O
Series filters out ZIP Codes that do not reside in the same state as the post office in the address.
Note: If the ZIP Code filtering would result in zero retrieved tax areas, Vertex O Series does not
apply ZIP Code filtering.
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = true

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 5. TaxGIS parameters | 149

Filter Postal Area Given No Zip

This setting indicates whether or not Postal Delivery Names are filtered out of the set of tax
areas that are returned from TaxGIS.
This is done to improve the precision of the returned tax areas.
The United States Postal Service, to improve the efficiency of mail delivery, sometimes identifies
addresses by the name of the city nearest to the address, even though the address may not be
located within the boundaries of the city. This can cause errors when using addresses to identify
tax jurisdictions.
To avoid these errors, set this value to true. This enables Vertex O Series to associate Postal
Delivery Names with the appropriate tax jurisdiction, rather than the city. This filtering takes
place only if no ZIP Code is included as part of the address, and is valid only for addresses in the
US. If more than one tax jurisdiction is associated with the address, Vertex O Series returns all
associated tax jurisdictions.
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = false

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 5. TaxGIS parameters | 150

Filter Postal Area Given Zip 5

This setting enables filtering of Postal Delivery Names when multiple tax areas are retrieved
using a ZIP Code of five numeric characters.
In some cases, Postal Delivery Names are identified by a city name that is not actually inside the
city boundary. To alleviate the issue of misidentifying jurisdictions, Vertex associates these
Postal Delivery Names with the actual jurisdictions.
In some cases, using the ZIP Code in an address enables the Vertex O Series to appropriately
select the set of jurisdictions that is associated with the transaction address. In other cases, you
must choose between two or more choices that include the given address.
When this setting is enabled and multiple tax areas are retrieved, the tax areas that are
designated as Postal Delivery Names are filtered from the result set. If the filtering would
eliminate all tax areas, the tax areas are not filtered from the result set.
This setting applies only to Tax Area Lookups where a United States address containing a ZIP
Code of five numeric characters is provided as input. If a full ZIP Code of nine numeric
characters is provided, the Filter Postal Area Given ZIP 9 (see page 151) setting is applied
instead.
Possible values are true (to enable) and false (to disable).
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = false

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 5. TaxGIS parameters | 151

Filter Postal Area Given Zip 9

This setting enables filtering of Postal Delivery Names when multiple tax areas are retrieved
using a ZIP Code of nine numeric characters.
In some cases, Postal Delivery Names are identified by a city name that is not actually inside the
city boundary. To alleviate the issue of misidentifying jurisdictions, Vertex associates these
Postal Delivery Names with the actual jurisdictions.
In some cases, using the ZIP Code in an address enables Vertex O Series to appropriately select
the set of jurisdictions that is associated with the transaction address. In other cases, you must
choose between two or more choices that include the given address.
When this setting is enabled and multiple tax areas are retrieved, the tax areas that are
designated as Postal Delivery Names are filtered from the result set. If the filtering would
eliminate all tax areas, the tax areas are not filtered from the result set.
This setting applies only to Tax Area lookups where a United States address containing a ZIP
Code of nine numeric characters is provided as input. If a ZIP Code of five numeric characters is
provided, the Filter Postal Area Given Zip 5 (see page 150) setting is applied instead.
Possible setting values are true (to enable) and false (to disable).
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = false

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 5. TaxGIS parameters | 152

Filter Postal County Area

This setting activates or deactivates Postal County Areas.
The United States Postal Service (USPS) governs mail distribution in the United States. Postal
geography frequently does not line up with the jurisdictions that are used for tax compliance.
For example, to make it convenient and efficient to deliver mail, the USPS assigns all addresses
within a given ZIP Code to a single county, even if that ZIP Code exists in multiple counties.
Vertex refers to these additional counties as Postal County Areas.
Valid values for this setting are true and false. When you set the setting value to true and
multiple tax areas are retrieved, the tax areas designated as Postal County Areas are filtered
from the result set. Tax areas are not filtered from the result set if the filtering would result in
zero tax areas being returned.
When third-party address cleansing software processes an address, Vertex O Series populates
the postal county. This postal county may be different from the county of the physical location
for the address that you entered. Postal County Areas enable you to pass the cleansed input
address and return a Tax Area ID that reflects the physical location. If you do not want to return
tax areas for postal county areas, setting this flag to true filters out the tax areas that match the
corresponding postal county area.
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = false

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 5. TaxGIS parameters | 153

Filter Postal Unincorporated Area

This setting enables filtering of tax areas for unincorporated areas from the results of a lookup
for a United States address. An unincorporated area of a county consists of the county areas
outside the boundaries of the incorporated areas (areas that have met the legal requirements
to become an incorporated municipality). Possible settings are true (to enable) and false (to
disable).
When this setting is enabled, the tax areas in the lookup results that are marked as
unincorporated areas are excluded from the results. If all the tax areas in the results are marked
as unincorporated, then all the tax areas are included in the results.
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = false
Note: This setting replaces the [Link] parameter
that was previously found in the [Link] file.

Match Prefix For Region Types

This setting defines the address fields (region types) that accept prefixes.
For example, if the city region type can accept prefixes, an address with PHILA as the city
matches PHILADELPHIA. Possible region types include:
• MAIN_DIVISION
• SUB_DIVISION
• CITY
• POSTAL_CODE
The region types in the list are delimited with a pipe character ( | ).
There is no default value for this setting.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 5. TaxGIS parameters | 154

Match Prefix For Region Types (Calc Override)

This setting defines the address fields (region types) that accept prefixes.
It overrides the Match Prefix For Region Types (see page 153) setting during the tax calculation.
For example, if the city region type can accept prefixes, an address with PHILA as the city
matches PHILADELPHIA. The following are possible region types:
• MAIN_DIVISION
• SUB_DIVISION
• CITY
• POSTAL_CODE
The region types in the list are delimited with a pipe character ( | ).
There is no default value for this setting.

Maximum Full Addresses

This setting defines the maximum number of full addresses that can be returned during a
lookup.
The default value indicates that no more than 100 full addresses are returned during lookup.
Default = 100

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 5. TaxGIS parameters | 155

Maximum Tax Areas

This setting defines the maximum number of tax areas that can be returned during a lookup.
This can be used to prevent large numbers of tax areas from being returned when a specified
location is vague, such as when only a state is specified.
When the value is set to 1, Vertex O Series returns the first alphabetical jurisdiction.
This setting can be overridden for tax calculation by using the Maximum Tax Areas (Calc
Override) setting.

Default = 5

Maximum Tax Areas (Calc Override)

This setting overrides the Maximum Tax Areas (see page 155) setting for tax calculation.
This setting defines the maximum number of tax areas that can be returned during a lookup.
This can be used to prevent large numbers of tax areas from being returned when a specified
location is vague, such as when only a state is specified.
If the field is blank or has a value of 0, the TaxGIS setting is used. Tax area lookups without tax
calculation continue to use the TaxGIS setting.
There is no default value for this setting.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 5. TaxGIS parameters | 156

Minimum Aggregate Confidence

This setting enables you to limit the number of tax areas that O Series returns in a tax area
lookup by setting a Minimum Aggregate Confidence value.
When Vertex O Series identifies multiple tax areas for a lookup, the tax areas' confidence
indicators enable you to identify the tax areas of which Vertex is most confident.
Vertex O Series sums the confidence indicators for the returned tax areas until the sum reaches
this setting's value. When the minimum aggregate confidence value for a given lookup is
reached, no additional tax areas are returned.
For any given lookup, the sum of the confidence indicators does not exceed this value, but it
may be less than this value. The exception is when Vertex O Series includes additional tax areas
because they share the same confidence indicator value as the tax area in the lookup that has
the lowest confidence value.
Valid values for this setting are integers between 0 and 100. If you do not specify any other
confidence-related settings, then Vertex O Series uses the value of this setting.
Default = 100

Number Of Address Cleansing Lookup Attempts

This setting indicates the maximum number of Address Cleansing requests that Vertex O Series
attempts before returning a failure message or continuing the Tax Area Lookup with the
original, uncleansed address.
The final course of action is determined by the Continue If Address Cleansing Unavailable
setting.
Valid values for this setting are any integer greater than zero.
Note: This setting is enabled only when the Use Address Cleansing setting is set to true.
Default = 3

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 5. TaxGIS parameters | 157

Use Special Characters

This setting enables you to use addresses that contain special characters, such as accents marks,
in a tax area lookup.
Special characters are symbols above or below a letter that change its pronunciation. For a
specific list of supported special characters, refer to the XML Integration Guide or the Java
Integration Guide.
Set the value to true to use special characters for all tax area lookups. Special characters are
mapped to their corresponding characters in English. For example, Montréal, Canada is
converted to Montreal, Canada before a tax area lookup.
If you select the Use Special Characters check box in Tools > Tax Area Lookup, special characters
apply only to the current tax area lookup.
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = false

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 5. TaxGIS parameters | 158

Retrieve Full Vertex Addresses

This setting indicates whether associated addresses are retrieved along with the tax area during
a Tax Area Lookup by address.
This is useful when the given address is only partially populated and you need to know the full
address.
This setting applies only to Tax Area Lookups by address with United States and Canadian
addresses.
When this setting is enabled, the Maximum Full Addresses setting and the Maximum Tax Areas
setting are used to determine the number of results that are returned during a Tax Area Lookup.
If the maximum set in either of these parameters is reached, no additional records are retrieved
and any results accumulated to that point are returned.
Possible settings are true (to enable) and false (to disable). When the check box is selected, the
value is true. When the check box is cleared, the value is false. Set the value to true when you
are performing a Tax Area Lookup with United States addresses. Otherwise, accept the default
value (false).
Note: This setting replaces the [Link] parameter that
was previously found in the Vertex configuration file ([Link]).
Default = false

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 5. TaxGIS parameters | 159

Override default Canada postal code setting

([Link]
de)
Add this parameter to the [Link] file and set it to true to return a full postal code for a
Canadian jurisdiction in Tax Area Lookup:
[Link]=true

Use this parameter in conjunction with selecting Retrieve Full Vertex Addresses (see page 158)
in System > Administration > Settings.
Default=false

Required Region Types For Address

This setting defines the required address fields (region types) for a Tax Area Lookup.
It specifies the global setting for required address fields. To override the global setting, click the
+ icon and enter one of the following possible region types in the Child Name field:
• COUNTRY
• MAIN_DIVISION
• SUB_DIVISION
• CITY
• POSTAL_CODE
The region types in the list are delimited with a pipe character ( | ).
For example:
To enforce that the city and postal code address fields are populated for an address,
enter the following in the Child Name field:
CITY|POSTAL_CODE

There is no default value for this setting.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 5. TaxGIS parameters | 160

Required Region Types For Address (Calc Override)

This setting overrides the Required Region Types For Address (see page 159) setting for tax
calculation.
This setting defines the required address fields (region types) for a Tax Area Lookup for tax
calculation. It specifies the global setting for required address fields. To override the global
setting, click the + icon and enter one of the following possible region types in the Child Name
field:
• COUNTRY
• MAIN_DIVISION
• SUB_DIVISION
• CITY
• POSTAL_CODE
The region types in the list are delimited with a pipe character ( | ).
For example, to enforce that the city and postal code address fields are populated for an
address, enter the following in the Child Name field:
CITY|POSTAL_CODE
Tax area lookups without tax calculation continue to use the TaxGIS setting.
There is no default value for this setting.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 5. TaxGIS parameters | 161

Retrieve Second Street Line in Address

Cleansing
This setting enables you to use a second street line in Address Cleansing. Valid values are true
and false.
When the setting value is true and the cleansed address has a second street line value, the
second street line in the address contains the second street line value.
When the setting value is false, the second street line value is returned as part of the primary
street line.
Note: You must set the Use Address Cleansing setting to true before you set this setting.
Otherwise, Vertex O Series ignores this setting.
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = false

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 5. TaxGIS parameters | 162

Retrieve Second Street Line in Address Cleansing (Calc Override)

This setting overrides the Retrieve Address Cleansing Second Street Line (see page 160) setting
for tax calculation.
This setting enables you to use a second street line in Address Cleansing. Valid values are Use
TaxGIS Value, true, and false.

When the setting value is Use TaxGIS Value, the value that is used by the Retrieve Address
Cleansing Second Street Line (see page 160) setting is used.
When the setting value is true and the cleansed address has a second street line value, the
second street line in the address contains the second street line value for tax calculation.
When the setting value is false, the second street line value is returned as part of the primary
street line for tax calculation.
Note: Before you set this setting, you must either set the Use Address Cleansing (Calc Override)
(see page 165) setting to true, or set the value of Use Address Cleansing (Calc Override)
(see page 165) to Use TaxGIS Value and the value of the Use Address Cleansing (see page
164) setting to true. Otherwise, Vertex O Series ignores this setting.
Default = Use TaxGIS Value

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 5. TaxGIS parameters | 163

Retrieve Cleansed Address

This setting indicates the address that a lookup returns. You must have purchased this
component and be licensed to use this feature.
Valid values for this setting are FULL and NONE.

When to use FULL

If you always want to call Address Cleansing first, set the value to FULL. Address Cleansing is
always called first and Address Cleansing returns the cleansed address. The service ignores the
value of the Address Cleansing Processing Order setting.

When to use NONE

If you want Vertex O Series to check when a TaxGIS lookup or an Address Cleansing request
occurs, set the value to NONE. The system checks the value of the Address Cleansing Processing
Order setting, which determines the sequence of each lookup. Finally, the system checks the
value of the To Retrieve Full Vertex Addresses setting to determine whether or not to return
Vertex address information. If this value is set to true, the system returns Vertex address
information. If this value is set to false, the system returns no address information.
Vertex O Series does not include standard Vertex address information in the XML response
message for a tax calculation.
Note: This setting is enabled only when the Use Address Cleansing setting is set to true.
Default = NONE

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 5. TaxGIS parameters | 164

To Preload All Tax Areas And Jurisdictions

This setting indicates whether all tax areas and jurisdictions are preloaded into memory before
performing any lookup.
Possible values are true (to enable) and false (to disable).
When this setting is enabled, all the tax areas and jurisdictions are loaded from the TaxGIS
database into memory.
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Note: This setting displays only for Master Administrators when the Scope option is set to
System.

Default = true

Use Address Cleansing

This setting indicates if Address Cleansing is enabled.
Address Cleansing improves the granularity of your Tax Area Lookups. Address Cleansing applies
only to United States addresses. You need to enter street address information and one of the
following: city, state, or postal code.
You must have purchased this component and be licensed to use this feature. Otherwise, the
Use Address Cleansing check box is unavailable on the Vertex O Series Tools > Tax Area Lookup
pages.
Valid values for this setting are true and false.
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = false

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 5. TaxGIS parameters | 165

Use Address Cleansing (Calc Override)

This setting overrides the Use Address Cleansing (see page 164) setting for tax calculation.
You must have purchased this component and be licensed to use this feature.
Valid values for this setting are Use TaxGIS Value, true, and false.
When the value is Use TaxGIS Value, the Use Address Cleansing (see page 164) setting value is
used. When the value is true, Address Cleansing is enabled for tax calculation. When the value
is false, Address Cleansing is disabled for tax calculations.
Default = Use TaxGIS Value

Use Vertex Compression Logic City

This setting indicates whether Vertex compression logic is used when standardizing a city name
for an address during a lookup.
Compression logic enables your search to match city, main division, sub division, and country
names based on phonetic spelling and word concatenations. It helps you to successfully look up
tax areas when you do not know the correct spelling of a location. For example, compression
logic enables a search for "pitsberg" to find Pittsburgh.
When the compression logic is disabled, Tax Area Lookup Search Results display only results
that exactly match the letters entered in the search criteria.
Possible setting values are true (to enable) and false (to disable).
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = true

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 5. TaxGIS parameters | 166

Use Vertex Compression Logic City (Calc Override)

This setting overrides the Use Vertex Compression Logic City (see page 165) setting for tax
calculation.
This setting indicates whether Vertex compression logic is used when standardizing a city name
for an address during a lookup for tax calculation. Possible settings are Use TaxGIS Value, true,
and false.
When the value is Use TaxGIS Value, the Use Vertex Compression Logic City (see page 165)
setting value is used. When the value is true, compression logic is enabled for tax calculation.
When the value is false, compression logic is disabled for tax calculation.
Default = Use TaxGIS Value

Use Vertex Compression Logic Country

This setting indicates whether Vertex compression logic is used when standardizing a country
name for an address during a lookup.
Compression logic enables your search to match city, main division, sub division, and country
names based on phonetic spelling and word concatenations. It helps you to successfully look up
tax areas when you do not know the correct spelling of a location. For example, compression
logic enables a search for "pitsberg" to find Pittsburgh.
When the compression logic is disabled, Tax Area Lookup Search Results displays only results
that exactly match the letters entered in the search criteria.
Possible settings are true (to enable) and false (to disable).
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = true

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 5. TaxGIS parameters | 167

Use Vertex Compression Logic Country (Calc Override)

This setting overrides the Use Vertex Compression Logic Country (see page 166) setting for tax
calculation.
This setting indicates whether Vertex compression logic is used when standardizing a country
name for an address during a lookup. Possible settings are Use TaxGIS Value, true, and false.
When the value is Use TaxGIS Value, the Use Vertex Compression Logic Country (see page 166)
setting value is used. When the value is true, compression logic is enabled for tax calculation.
When the value is false, compression logic is disabled for tax calculation.
Default = Use TaxGIS Value

Use Vertex Compression Logic Main Division

This setting indicates whether Vertex compression logic is used when standardizing a main
division name for an address during a lookup.
Compression logic enables your search to match city, main division, sub division, and country
names based on phonetic spelling and word concatenations. It helps you to successfully look up
tax areas when you do not know the correct spelling of a location. For example, compression
logic enables a search for "pitsberg" to find Pittsburgh.
When the compression logic is disabled, Tax Area Lookup Search Results displays only results
that exactly match the letters entered in the search criteria.
Possible settings are true (to enable) and false (to disable).
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = true

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 5. TaxGIS parameters | 168

Use Vertex Compression Logic Main Division (Calc Override)

This setting overrides the Use Vertex Compression Logic Main Division (see page 167) setting for
tax calculation.
This setting indicates whether Vertex compression logic is used when standardizing a main
division name for an address during a lookup. Possible settings are Use TaxGIS Value, true, and
false.

When the value is Use TaxGIS Value, the Use Vertex Compression Logic Main Division (see page
167) setting value is used. When the value is true, compression logic is enabled for tax
calculation. When the value is false, compression logic is disabled for tax calculation.
Default = Use TaxGIS Value

Use Vertex Compression Logic Sub Division

This setting indicates whether Vertex compression logic is used when standardizing a sub
division name for an address during a lookup.
Compression logic enables your search to match city, main division, sub division, and country
names based on phonetic spelling and word concatenations. It helps you to successfully look up
tax areas when you do not know the correct spelling of a location. For example, compression
logic enables a search for "pitsberg" to find Pittsburgh.
When the compression logic is disabled, Tax Area Lookup Search Results displays only results
that exactly match the letters entered in the search criteria.
Possible settings are true (to enable) and false (to disable).
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = true

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 5. TaxGIS parameters | 169

Use Vertex Compression Logic Sub Division (Calc Override)

This setting overrides the Use Vertex Compression Logic Sub Division (see page 168) setting for
tax calculation.
This setting indicates whether Vertex compression logic is used when standardizing a sub
division name for an address during a lookup. Possible settings are Use TaxGIS Value, true, and
false.

When the value is Use TaxGIS Value, the Use Vertex Compression Logic Sub Division (see page
168) setting value is used. When the value is true, compression logic is enabled for tax
calculation. When the value is false, compression logic is disabled for tax calculation.
Default = Use TaxGIS Value

User Defined Address Mappings

([Link]
appingsFile)
This parameter setting enables you to add customized address names for Tax Areas or
addresses through a text file.
This text file enables TaxGIS to map an input address field to a corresponding output address
field. Specify the text file name and location using this parameter.
Specify the name of file using a fully qualified or relative path to Vertex Home. Use forward
slashes (/) to represent directory paths. For example:
C:/VertexHome/[Link]

Default = none

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 5. TaxGIS parameters | 170

How user-defined address lookup works

User-defined address lookup involves TaxGIS evaluating the various parts of a transaction
address, such as street, city, and postal code, during lookup and matching each respective part
to an input address in a user-defined mapping file.
A user-defined mapping file is a text file that contains specific variations in the spelling of input
addresses that you want assigned to a corresponding output address. Typically, you include
these customized address names as input address fields in this text file. This text file enables
TaxGIS to map an input address field to a corresponding output address field.

How to set up user-defined address lookup

Set the following parameters in the [Link] file:
• [Link] (see page 169)
• [Link] (see page 175)
• [Link]

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 5. TaxGIS parameters | 171

Best practice: When to create a user-defined address mapping file

A user-defined mapping file is a text file that contains specific variations in the spelling of
addresses that you want mapped to a corresponding Tax Area ID or address.
Vertex recommends that you create a user-defined address mapping file if you have spellings
for any of the following not supported by Vertex:
• City
• County
• State
• Province
• Territory
• Country
During TaxGIS Lookup, available addresses in TaxGIS that match the values in the user-defined
address mapping file are assigned the corresponding output Tax Area ID or address on the same
record. TaxGIS then continues the lookup using the retrieved Tax Area ID or address. If both a
Tax Area ID and address are specified on the same record, TaxGIS uses the Tax Area ID during
lookup.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 5. TaxGIS parameters | 172

Input fields in the text file

The text file associated with the [Link] (see
page 169) parameter is a tilde (~)-delimited file. This text file supports Unicode.
Each new line in the text file is an individual record. Each field in a record is separated by a tilde
(~). The records within the file are processed in the order that they display in the file. When a
record is matched, the records continue to be processed to determine if another match is
found. The output fields from the record that is matched last is used in the Tax Area Lookup.
The Input Address fields can use wildcard matching to search for groups of addresses. The two
wildcards supported are:
• Asterisk (*)
• Percent symbol (%)
Use the asterisk to match zero or more characters. For example, entering * Martin Drive as the
Input Street Address would find all addresses containing the phrase Martin Drive.
Use the percent symbol to match exactly one character. For example, entering 1810% as the
Postal Code would find all codes with 1810 as the first numbers in the code.
Review the following table for descriptions of input and output fields:

Fields Description

Input fields
Input Effective Date The format of the date is Year Month Day (YYYYMMDD). If
this field is blank, the default date is 19000101.
Input Expiration Date The format of the date is Year Month Day (YYYYMMDD). If
this field is blank, the default date is 99991231.
Input Street Address The street name in the input address.
Input City The city name in the input address.

Input Sub Division The sub division name in the input address.

Input Main Division The man division name in the input address. Values are
abbreviations or full names, such as PA or Pennsylvania.
Input Postal Code The postal code in the input address.

Input Country The country name in the input address. Values are
abbreviations or full names, such as USA or United States.
Output fields

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 5. TaxGIS parameters | 173

Fields Description

Output Tax Area ID The Tax Area ID used in TaxGIS Lookup.

Output Street Address The street name used in TaxGIS Lookup.
Output City The city name used in TaxGIS Lookup.
Output Sub Division The sub division name used in TaxGIS Lookup.
Output Main Division The main division name used in TaxGIS Lookup.
Output Postal Code The postal code used in TaxGIS Lookup.
Output Country The country used in TaxGIS Lookup.

Best practice: Entering data in the text file

The input and output fields in the text file enable you to customize address name spellings for
tax area lookups or address lookups.
Vertex requires that you enter the following:
• Data in at least one input address field.
If you leave an input address field blank in the text file, TaxGIS lookup matches any value in
the transaction address.
If you leave an output address field blank in the text file, TaxGIS uses the current value in the
transaction address.
• Data in either the output Tax Area ID or one output address field.
If you enter a Null value in an input address field in the text file, TaxGIS lookup continues
only if the corresponding field on the transaction address is blank or Null. Otherwise, TaxGIS
cannot complete the mapping.
Caution: If you enter Null for an input country field, TaxGIS cannot process the record.
If you enter a Null value in an output field, TaxGIS overwrites the corresponding transaction
address field with Null.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 5. TaxGIS parameters | 174

Guideline: Limit the number of entries in the text file associated with
[Link]
Limit the number of entries in the text file associated with the
[Link] (see page 169) parameter. While
there is no maximum number of Tax Areas or address entries that can be included in the text
file, a large number of entries in the text file may impact O series performance and processing
speed.

Guideline: Troubleshooting warning messages

If your Tax Area or address lookup generates a warning message, check for the following
conditions in the text file. You might have:
• Left all input or output fields blank. You need to specify at least one input and output field.
• Set the input Country field to Null. A record with this value is not used by TaxGIS.

Wait Time For Address Cleansing Retry

This setting indicates the number of minutes that TaxGIS waits before attempting to cleanse an
address after the defined number of retries was reached for a previous Address Cleansing
request that failed.
The defined number of retries is set in the Number Of Address Cleansing Lookup Attempts
setting.
The system attempts to process Tax Area Lookups by using the original uncleansed address until
it reaches the wait time limit.
This setting applies only if the Continue If Address Cleansing Unavailable setting value is set to
true.

Valid values are any positive integer. A zero value indicates that there is no wait time between
Address Cleansing attempts.
Default = 5

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 5. TaxGIS parameters | 175

Setting time before refreshing the user-defined

address mappings file
([Link]
appingsFileRefreshDelay)
This parameter setting enables you to set the minimum time lapse before Vertex O Series
refreshes the contents of the user-defined address map file.
The refresh occurs during heartbeat processing.
For details on setting up user-defined text files for Tax Areas or addresses lookup, refer to
[Link].
The default value represents total milliseconds (300000 milliseconds represents 5 minutes).
Default = 300000

TaxGIS Transaction Dump

This setting enables you to include Tax Area Lookup information in the Log file.
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = false

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
Chapter 6. Custom Reports - VRA and
Reports-related parameters
Reports parameters enable you to generate and store reports on your system. These
parameters let you customize the location of these reports.

In this chapter
Parameters for integration with Legacy Vertex Reporting & Analysis
(Legacy VRA) ...............................................................................176
Turning report streaming on and off ([Link].)178
Change the output for reports from a PDF file to a text file
([Link]) ....................................178
Changing the appearance of standard reports ...........................179

Parameters for integration with Legacy Vertex

Reporting & Analysis (Legacy VRA)
If you use or plan to use Legacy Vertex® Indirect Tax Reporting & Analysis with O Series, there
are two parameters that you must manually change in the [Link] file.
These parameters are as follows:
• [Link]
• [Link]
Note: You can have only one Cognos username and one Cognos password. These values must
match the username and password values that are stored in the [Link] file
within Cognos.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 6. Custom Reports - VRA and Reports-related parameters | 177

Set the COGNOS user name ([Link])

This parameter defines the user name that is needed to access Cognos from O Series to use
Legacy VRA.
The value of this parameter must match the value of the user name entry in the
[Link] file that resides on the Cognos server.
The parameter is in the following format:
[Link]=XXXXX

where:
XXXXX is the user name. The user name can be any length and can use alphanumeric or
special characters.
This parameter has no default value.

Set the COGNOS password ([Link])

This parameter defines the user name that is needed to access Cognos from O Series to use
Legacy VRA.
The value of this parameter must match the value of the password entry in the [Link]
file that resides on the Cognos server.
The parameter is in the following format:
[Link]=XXXXX

where:
XXXXX is the password

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 6. Custom Reports - VRA and Reports-related parameters | 178

Turning report streaming on and off

([Link].)
This parameter sets whether a report will be streamed directly to a database as it is being
generated, or completely built in memory before being written to a database.
Vertex recommends that you set this parameter to true when generating large reports that may
cause problems if attempted to be completely built in memory.
Note: If the report is streamed directly to a database, it will not have the cell formatting that
built-in-memory reports have.
The parameter is in the following format:
[Link]=true or false
Default = true

Change the output for reports from a PDF file to

a text file
([Link])
This parameter setting defines the output for reports as a text file rather than a Postscript Data
File (PDF).
Set this parameter equal to 2 to generate your report as a text file.
A report generated as a text file is created three times faster than a PDF. However, the file size
of the text file is significantly larger than the PDF file.
Default = 1 (PDF)

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 6. Custom Reports - VRA and Reports-related parameters | 179

Changing the appearance of standard reports

The following parameters enable you to change the fonts that are used in O Series standard
reports to make them more easily readable.

Setting bold body text ([Link])

This parameter setting enables you to set the bolded body text style for standard reports that
contain Unicode characters.
The default font is Arial. The default value is the directory location of the file containing the Arial
True Type Font (TTF) for Unicode.
Default = c:/windows/fonmts/arial;[Link]

Setting page width to accommodate Unicode characters

([Link])

This parameter setting enables you to set the page width for standard reports that contain
Unicode characters.
Default = Identity-H

Setting the plain body text style

([Link])

This parameter setting enables you to set the plain body text style for standard reports that
contain Unicode characters. The default font is Arial.
The default value is the directory location of the file containing the Arial True Type Font (TTF)
for Unicode.
Default = c:/windows/fonmts/arial;[Link]

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
Chapter 7. General Parameters
General parameters include parameters that may affect common O Series functionality.

In this chapter
Accumulator Cache Initial Years .................................................181
Accumulator Cache Refresh Delay..............................................182
Allow Historical Edits ..................................................................182
Allow Tax Journal Export update date
([Link]) .........................................183
Auto Populate Search Results.....................................................183
Cache Refresh Delay ...................................................................184
Custom Label 1 -10 .....................................................................185
Custom Label 2 ...........................................................................185
Custom Lookup Label .................................................................186
Custom Lookup List ....................................................................187
Default Business Event ...............................................................187
Default Currency ........................................................................188
Default Currency Code ...............................................................188
Default Freight Category Code ...................................................188
Default Locale .............................................................................189
Default Taxability Drivers Sharing...............................................189
Default Transaction Type............................................................189
Enabling accumulation ...............................................................190
Jurisdictions ................................................................................190
Landing Page ..............................................................................191
Always Return Effective Rate......................................................191
Calculation Time Limit ................................................................192
Limit the number of tax rules loaded
([Link]) ...........193
Max Vendor Summaries .............................................................194
Max Category Mapping Summaries............................................194
Max Certificate Summaries ........................................................194
Max Commodity Code Summaries .............................................195
Max Customer Summaries .........................................................195
Max Task Log Summaries ...........................................................195
Max Tax Rule Summaries ...........................................................196
Maximum Bracket Schedule Size
([Link]) ...........................196
Maximum Calculation Iterations

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 7. General Parameters | 181

([Link]) ..........................197
Maximum Posting Date Threshold .............................................197
Maximum Taxability Driver Summaries ......................................198
Minimum Posting Date Threshold ..............................................198
Number of Threads for Retail Tax Extract...................................199
Override the default list of allowed uploadable file types
([Link]) .........................................................199
Transactional Logging Threshold Limit .......................................200
Taxability Categories ..................................................................201
Use Assisted Tax Date.................................................................201
Returns Export parameters ........................................................202
Transaction Tester-related parameters ......................................202

Accumulator Cache Initial Years

This setting enables you to load data into the Accumulator cache based on the specified number
of years, instead of loading all data for all years.
For example, with the default setting of 1, the system loads only cached data that is dated one
year from the As of Date. For example, if the As Of Date is 01/01/2020, the system loads only
cached data from 01/01/2019 and later.
Default = 1

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 7. General Parameters | 182

Accumulator Cache Refresh Delay

This setting enables you to define the minimum number of milliseconds between accumulator
cache refresh updates.
Note: To set a refresh time for cache updates that are not related to accumulation, use the
Cache Refresh Delay setting.

Possible values are 100 to 172800000 (48 hours). Vertex recommends that you keep the default
value for this setting.
Caches are refreshed only during heartbeat processing. Refresh values are always rounded to
the next whole number increment of master controller heartbeats.
Default = 300000

Allow Historical Edits

This setting enables you to edit historical data in My Enterprise and Tax Setup.
Use this setting in tandem with the As of Date to do the following:
• Set a date that precedes the current system date of the Vertex O Series system at your
location.
• Edit data with respect to that historical date.
You can create new entries in My Enterprise and Tax Setup with an As of Date in the past, which
then creates a historically effective record.
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = false
Notes:
• For audit reasons, Vertex strongly recommends that this parameter be set to false in Vertex
O Series production instances.
• You must log out of Vertex O Series and log back in for this setting to take effect.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 7. General Parameters | 183

Allow Tax Journal Export update date

([Link])
When this parameter is set to true, and the user is designated a Master Administrator, the Tax
Journal Export process exports only data that was updated since the last posting date.
Default = true

Auto Populate Search Results

This preference enables you to define whether Vertex O Series automatically populates search
results when you navigate to an entity page.
Valid values for this preference are: Taxpayers, Customers, Vendors, Taxability Drivers, and
Certificates. You can specify more than one value.

Default = Taxpayers

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 7. General Parameters | 184

Cache Refresh Delay

This setting enables you to define the minimum number of milliseconds between cache refresh
updates.
Note: To set a refresh time for cache updates that are related to accumulation, use the
Accumulator Cache Refresh Delay setting.

Possible values are 100 to 172800000 (48 hours). Vertex recommends that you keep the default
value for this setting.
Caches are refreshed only during heartbeat processing. Refresh values are always rounded to
the next whole number increment of master controller heartbeats.
To support system performance, only newly added and changed certificates are reloaded during
a certificate cache refresh.
Note: This setting displays only for Master Administrators when the Scope option is set to
System.

Default = 300000

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 7. General Parameters | 185

Custom Label 1 -10

If your organization has a business need to enter customer data - such as business unit names
and locations - outside of the Vertex-provided fields, each of these preferences enables you to
name a user-defined Customer field. These fields are located on the Customer page's Custom
Fields tab.

Valid values for these preferences are any alphabetic or numeric value between 1 and 60
characters.
Default = Field 1 - 10

Custom Label 2
If your organization has a business need to enter customer data outside of the Vertex-provided
fields, this preference enables you to name a user-defined customer field. This field is located
on the Customer page's General tab.
Valid values for this preference are any alphabetic or numeric value between 1 and 60
characters.
Default = Field 2

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 7. General Parameters | 186

Custom Lookup Label

If your organization has a business need to enter customer data - such as business unit names
and locations - outside of the Vertex-provided fields, this preference enables you to name a
user-defined drop-down list. This drop-down list is located on the Customer page's Custom
Fields tab.

Preferences feature Customers feature

Valid values for this preference are any alphabetic or numeric value between 1 and 60
characters.
Default = Custom Lookup

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 7. General Parameters | 187

Custom Lookup List

If your organization has a business need to enter customer data - such as business unit names
and locations - outside of the Vertex-provided fields, this preference enables you to create
selections for a user-defined drop-down list. This drop-down list is located on the Customer
page's Custom Fields tab.

Preferences feature Customers feature

Click ADD to create additional selections.

Valid values for this preference are any alphabetic or numeric value between 1 and 60
characters.
There is no default value for this preference.

Default Business Event

This preference indicates the business event – either Supplies or Procurement – that is selected
on the contextual bar when you log in to Vertex O Series.
If a user does not have permissions to one or the other business event, be sure to set the
default to the event for which that user has permissions.
Default = Supplies

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 7. General Parameters | 188

Default Currency
This preference indicates the default currency type that the Calculation Engine uses to calculate
tax.
Valid values for this preference are three-character alphabetic ISO currency codes. Additional or
revised values may be available after you apply your monthly data update.
Default = USD

Default Currency Code

This setting indicates the default currency unit.
Default = USD

Default Freight Category Code

This setting enables you to override the default mapping for freight that occurs as a child-level
attribute in the line item.
Vertex O Series automatically maps freight that occurs as a child-level attribute in the line item
to Shipping and Handling Combined.
Use this setting if you want to map freight to a taxability category that more closely matches
your business needs. View a list of valid taxability category codes in the Setting Value drop-down
list.
For example, to override the default setting for freight to taxability category code Common
Carrier, FOB Destination, select Common Carrier, FOB Destination from the Setting Value
drop-down list.
Default = Shipping and Handling Combined Charge

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 7. General Parameters | 189

Default Locale
This preference indicates the default language that displays on the Vertex O Series user
interface.
The default and only option is en_US, which indicates English (United States).

Default Taxability Drivers Sharing

This preference sets the default state of the Share with other business events check box on the
Taxability Drivers, Commodity Codes, and Communications Service Codes pages.
The default state of the Share Taxability Driver check box is cleared and indicates that the
default state of any Share with other business events check boxes is cleared.
Select the Share Taxability Driver check box to set the default state of any Share with other
business events check boxes to selected.

Default Transaction Type

This preference indicates the default transaction type that the Calculation Engine processes to
calculate tax.
Valid values for this preference include:
• Sale
• Rental
• Lease
• Asset Movement
• Inventory Removal
Default = Sale

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 7. General Parameters | 190

Enabling accumulation
This setting enables the accumulation of transactions. When set to true, Vertex O Series
accumulates transactions.
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = false

Jurisdictions
This preference enables you to control the visibility of a jurisdiction in Vertex O Series features.
Select the check box next to a jurisdiction's name to display it in jurisdiction-selection lists, or
clear the check box to remove it from lists.
The Jurisdiction data identifies where the business entity is registered to collect tax.
The default value for this preference is all jurisdictions worldwide.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 7. General Parameters | 191

Landing Page
This preference indicates the Vertex O Series page that you want to set as your home page, as
selected from the Value(s) drop-down list on the Preferences Parameter Edit page.
Valid values for this preference may be modified in a monthly data update. Some useful default
landing pages include the following:
• Customers
• Extract Definitions
• Taxpayers
• Transaction Tester
The default is the Vertex® Indirect Tax O Series® home page.

Always Return Effective Rate

If your financial system requires it, this setting enables you to always return an effective rate of
tax - even when the tax amount is zero - for a given calculation.
When the value is set to true, Vertex O Series always returns this rate of tax.
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = false

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 7. General Parameters | 192

Calculation Time Limit

This setting indicates a time limit in milliseconds in which tax on a transaction is calculated.
A transaction fails if this time limit is exceeded and the result is not written to the Tax Journal.
Any valid positive number is a possible value.
For transactions with a large number of line items, increase the Calculation Time Limit to
300000 (5 minutes).
Default = 60000

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 7. General Parameters | 193

Limit the number of tax rules loaded

([Link]
xRules)
This parameter enables you to improve performance by limiting the number of tax rules that are
loaded into the Calculation Engine cache when your O Series server starts. Limiting the number
of tax rules uses less memory.
Only tax rules with an end date later than the date that was calculated with this parameter are
loaded into the cache. For example, setting this parameter to 365 and starting the server on
01/01/2017 loads all tax rules that were active in the last year – that is, between 01/01/2016
and 01/01/2017. Inactive tax rules with end dates that are older than one year are not loaded
into the cache.
The parameter is in the following format:
[Link]=xxx

where:
XXX is the age in number of days of tax rules that you do not want loaded into the cache.
The default is 365.
Notes:
• If you process credits and/or transactions using tax rules that expired more than 365 days
ago, you must change the default value.
• Vertex recommends that you periodically review transactions that are set up in your test
environment to remove or revise those transactions that use inactive tax rules.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 7. General Parameters | 194

Max Vendor Summaries

This preference specifies the maximum number of vendors that Vertex O Series returns when
you perform a search.
If the search results include more records than the maximum number for this preference,
Vertex O Series indicates the actual number of search results with a status message at the
bottom of the search results. For example, if you set this preference value to 50 but there are
actually 100 matching records, Vertex O Series displays the following message:
Only the first 50 of the 100 vendors matching search criteria returned!

Default = 1000

Max Category Mapping Summaries

This preference specifies the maximum number of category mappings that Vertex O Series
returns when you perform a search.
If the search results include more records than the maximum number for this preference,
Vertex O Series indicates the actual number of search results with a status message at the
bottom of the search results. For example, if you set this preference value to 50 but there are
actually 100 matching records, Vertex O Series displays the following message:
Only the first 50 of the 100 category mapping matching search criteria returned!

Default = 1000

Max Certificate Summaries

This preference enables you to set a maximum number of certificates that Vertex O Series
returns when you perform a search.
The value must be set to a whole number.
Default = 1000

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 7. General Parameters | 195

Max Commodity Code Summaries

This preference specifies the maximum number of commodity codes that Vertex O Series
returns when you perform a search.
If the search results include more records than the maximum number for this preference,
Vertex O Series indicates the actual number of search results with a status message at the
bottom of the search results. For example, if you set this preference value to 50 but there are
actually 100 matching records, Vertex O Series displays the following message:
Only the first 50 of the 100 commodity codes matching search criteria returned!

Default = 1000

Max Customer Summaries

This preference specifies the maximum number of customers that Vertex O Series returns when
you perform a search.
If the search results include more records than the maximum number for this preference,
Vertex O Series indicates the actual number of search results with a status message at the
bottom of the search results. For example, if you set this preference value to 50 but there are
actually 100 matching records, Vertex O Series displays the following message:
Only the first 50 of the 100 customers matching search criteria returned!

Default = 1000

Max Task Log Summaries

This preference indicates the maximum number of entries that are displayed in the Task Log.
Default = 1000

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 7. General Parameters | 196

Max Tax Rule Summaries

This preference specifies the maximum number of tax rules that Vertex O Series returns when
you perform a search.
If the search results include more records than the maximum number for this preference,
Vertex O Series indicates the actual number of search results with a status message at the
bottom of the search results. For example, if you set this preference value to 50 but there are
actually 100 matching records, Vertex O Series displays the following message:
Only the first 50 of the 100 tax rules matching search criteria returned!

For basis rules, however, the Vertex O Series message does not indicate the actual number of
search results. If there are more basis rules than what are returned in the search results, Vertex
O Series displays the following message:
Only the first 50 of the tax rules matching search criteria returned!

Default = 500

Maximum Bracket Schedule Size

([Link])
This configuration parameter enables you to set the maximum number of rows in a Retail Tax
Extract-generated bracket schedule.
Default=100

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 7. General Parameters | 197

Maximum Calculation Iterations

([Link])
This configuration parameter enables you to set the maximum number of trial calculations to
run when generating a Retail Tax Extract bracket schedule.
Default=200

Maximum Posting Date Threshold

This setting enables you to define the latest date for which a transaction Posting Date is
considered valid.
The Maximum Posting Date is a rolling date equal to the System Date plus the number of days
that are specified as the threshold. If a transaction Posting Date is later than the Maximum
Posting Date, then the Calculation Engine fails the transaction.
For example:
When the Maximum Posting Date Threshold is set to 2, and the System Date is
03/15/2019, no transactions with a posting date later than 03/17/2019 are calculated.
When the field value is 0, the Maximum Posting Date is the System Date.
When the field contains no value, the Maximum Posting Date is undefined and is not enforced.
There is no default value for this setting.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 7. General Parameters | 198

Maximum Taxability Driver Summaries

This preference specifies the maximum number of taxability drivers that Vertex O Series returns
when you perform a search.
If the search results include more records than the maximum number for this preference,
Vertex O Series indicates the actual number of search results with a status message at the
bottom of the search results. For example, if you set this preference value to 50 but there are
actually 100 matching records, Vertex O Series displays the following message:
Only the first 50 of the 100 taxability drivers matching search criteria returned!

Default = 1000

Minimum Posting Date Threshold

This setting enables you to define the earliest date for which a transaction Posting Date is
considered valid.
The Minimum Posting Date is a rolling date equal to the System Date minus the number of days
that are specified as the threshold. If a transaction Posting Date is earlier than the Minimum
Posting Date, then the Calculation Engine fails the transaction.
For example:
When the Minimum Posting Date Threshold is set to 2, and the System Date is
03/15/2019, no transactions with a posting date earlier than 03/13/2019 are calculated.
When the field value is 0, the Minimum Posting Date is the System Date.
When the field contains no value, the Minimum Posting Date is undefined and is not enforced.
There is no default value for this setting.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 7. General Parameters | 199

Number of Threads for Retail Tax Extract

This setting enables you to set the number of threads that are created to perform trial
calculations for the Retail Tax Extract.
If set to zero (0), one thread is created for each available processor (the number of available
processors as reported by the Java Virtual Machine (JVM)).
Note: This setting displays only for Master Administrators when the Scope option is set to
System.

Default=0

Override the default list of allowed uploadable

file types ([Link])
To avoid the potential for uploading malicious files, Vertex restricts the file types that can be
uploaded.
By default, only files with the following extensions can be uploaded: BMP, CSV, GIF, JIFF, JPEG,
JPG, PDF, PNG, RTF, TIF, TXT, WBMP, XLS, XLSX, XML, and ZIP.
You can override the default list of allowed extensions by adding the
[Link] parameter to the [Link] file and specifying a comma-separated
list of allowed extensions, as in the following example:
[Link]=.bat,.csv,.exe,.gif,.jpeg,.jpg,.pdf.,.png,.sql,.t
if, .txt,.xml

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 7. General Parameters | 200

Transactional Logging Threshold Limit

This setting restricts individual transactions from overriding the default logging threshold
beyond an allowable level.
The value represents the lowest level logging threshold that a transaction can specify to
override the default logging threshold.
The table below explains this setting's values:

Value What it logs

FATAL Any system condition or event that jeopardizes system integrity, such as allocation
failures, disk space errors, or major database problems.
ERROR All abnormal events that are neither warnings nor fatal.
WARNING Any system condition or event that is abnormal, but poses no risk to stability,
performance, or answer quality.
OPS Major system events, such as starting up or shutting down of major system components
(Recommended) or services. An OPS threshold returns messages from the OPS level and higher.

TRACE Entry and exit points of substantial classes and services.

DEBUG A detailed description of software execution.

There is no default value for this setting.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 7. General Parameters | 201

Taxability Categories
This preference enables you to control the visibility of a taxability category in Vertex O Series
features.
The default is that all categories and their associated subcategories are visible.
Taxability categories are groups of similar goods or services that have similar taxability and may
have special or conditional rules.
Specific examples of taxability categories include the following:
• Common/Interstate Carrier Drivers
• International Drivers
• Medical Drivers

Use Assisted Tax Date

Set at the partition level, this setting enables you to use either the original line-item date or the
assisted tax date, if available, to determine the effective Tax Assist rules to apply to a
calculation.
Valid values are true and false:
• When set to false, Vertex O Series uses the original line-item date in the request.
• When set to true, Vertex O Series uses, if it is available, the assisted tax date. This tax date
may have been updated by a previous Tax Assist rule.
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = false

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 7. General Parameters | 202

Returns Export parameters

Returns Export-related parameters enable you to define how to use specific aspects of Returns
Export.

Suppress the Physical Origin Tax Area ID in the Returns Export

([Link])

This parameter sets whether a Returns Export file includes the Physical Origin Tax Area ID
values.
When set to false, the Physical Origin Tax Area ID values are included in the Returns Export file.
When set to true, the Physical Origin Tax Area ID values are changed to zero. Setting this
parameter value to true may reduce the file size of the Returns Export file.
The parameter is in this format:
[Link]=<value>

where:
<value> is true or false

Default = false

Transaction Tester-related parameters

Transaction Tester is a window to the Vertex Calculation Engine. Using the Transaction Tester,
you can replicate transaction requests as sent from your host system and then review the
results from the Calculation Engine. Use the Transaction Tester to ensure that you are getting
the appropriate tax calculation results, based on the tax rules and rates for the transaction data
that you are sending.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 7. General Parameters | 203

Always process basis apportionment

When this setting is set to true, the basis apportionment is always processed.
Use this parameter for testing purposes only.
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Notes:
• Setting this parameter to true slows calculation performance. Vertex recommends turning it
on only when calculating turnover taxes in Argentina with Transaction Tester.
• This setting displays only for Master Administrators when the Scope option is set to System.
Default = false

Calculate Self-Accrual Indicator Default

This setting indicates whether the Calculate Self-Accrual check box for ERS transactions is
selected or cleared by default on the Other tab of the Transaction Tester.
If the value is set to true, the Calculate Self-Accrual check box is selected. If the value is set to
false, the Calculate Self-Accrual check box is cleared.

When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = false

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 7. General Parameters | 204

Show Tax Journal Button

This setting defines whether or not the Post To Journal button displays in Transaction Tester.
Caution: If you manually post transactions to the Tax Journal using Post to Journal, this
activity may result in your Tax Journal record being out of synchronization with
your host system.
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

When the value is set to true or if the user has permission based on a user-defined role, the
Post to Journal button displays in Transaction Tester for all financial events. Do not manually
post the following events to the Tax Journal:
• Quotation
• Purchase Order
• Invoice Verification
• Evaluated Receipts Settlement
If the value is set to false, the Post To Journal button does not display in Transaction Tester.
If you want to display this button only for specific users, grant them permissions under their
specific role.
Note: Permission to post to the Tax Journal is not included with any Vertex-supplied roles.
Default = false

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
Chapter 8. Batch Client Interface for O Series
Parameters
Batch Client Interface parameters include parameters that may affect Batch Client Interface
functionality. The parameters you need to set depend on the type of input you use and how
Batch Client Interface processes this input. You can:
• Process flat file input through the Batch Client Interface in Data Management via the O
Series user interface (see page 205)
• Process database input through Batch Client Interface as a web service (see page 206)
• Process a remote database through Batch Client Interface by passing transaction
information in a CSV file.
You can also perform Batch Client Interface processing using command line parameters. For
more details, refer to the Batch Client Interface Integration Guide.

In this chapter
Process flat file input via the Batch Client Interface in Data
Management ..............................................................................205
Process database input through Batch Client Interface as a web
service ........................................................................................206

Process flat file input via the Batch Client

Interface in Data Management
Review and set the following parameters when you perform a tax calculation by processing a
flat file via the Batch Client Interface. Navigate to System > Data Management.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 8. Batch Client Interface for O Series Parameters | 206

Polling frequency for batch calculations

([Link])

When new transactions are submitted via the user interface, this parameter setting defines the
number of seconds that the Batch Client Interface pauses during polling for these transactions
to process.
Default = 30

Setting the number of threads for batch calculation processing

([Link])

This parameter setting enables you change the number of threads that Vertex O Series can
manage during Batch Client Interface processing via System > Data Management > Batch Client
Interface.
The maximum thread count for this parameter is eight. If you change thread count to a value
greater than eight, the default value applies.
Note: When you increase the thread count, Vertex O Series performance may be impacted.
Consult your system administrator before you change the default value of this
parameter.
Default = 2

Process database input through Batch Client

Interface as a web service
Review and set the following parameters when you perform a tax calculation through Batch
Client Interface by processing database tables using a web service.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 8. Batch Client Interface for O Series Parameters | 207

How to enable Batch Client Interface as a web service

To enable Batch Client Interface as a web service, you must update your [Link] file with a
specific parameter that causes the Batch Client Interface utility to run automatically as a web
service.

Web service parameters

Batch Client Interface configuration file parameters can be required or optional. Some
parameters are used solely for testing or troubleshooting diagnostics purposes. As outlined in
the following sections, some parameters are set when you install Vertex O Series and some are
set manually.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 8. Batch Client Interface for O Series Parameters | 208

[Link] file parameters set by Vertex O Series installation

The core parameters are set when you install Vertex O Series:

Web service enabling parameter

This entry is required in [Link] to run Batch Client Interface as a web service:
[Link].11#vertex-ws=[Link].batch_client.[Link]
[Link]

When this parameter is added, BCI runs automatically as a web service when data is to be
processed from a database.
Note: The number in the parameter name (11) is set at installation time and may vary.

User authentication parameters

Use these required Batch Client Interface parameters to enter either a user name and password
or a Trusted ID parameter:
Parameter Value Purpose Additional information
[Link] User name User name for None
authentication purposes
[Link] Password User password for None
authentication purposes

Input database parameters

These required parameters identify the input data:
Parameter Value Purpose Additional information
[Link] Transaction Identifies the table that None
Name table name contains input transactions
for processing
[Link].BCI_DB Database Contains the database None
connection connection parameter for
the control and
transaction tables

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 8. Batch Client Interface for O Series Parameters | 209

Thread count parameter

Parameter Value Purpose Additional information
[Link] Thread count Enables multi-thread The default value is 2.
processing when multiple There is no maximum
CPUs are available on an number of threads.
application server

Batch transaction processing parameter

Parameter Value Purpose Additional information

[Link] Control table Identifies the table that None

name contains control data for
database batch transaction
processing

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 8. Batch Client Interface for O Series Parameters | 210

[Link] file parameters set manually

You set these optional parameters manually in [Link], if needed.

Transaction parameters
Parameter Value Purpose Additional Information
[Link] Unique transactions Ensures that each None
processed transaction is
unique
[Link] Identical document Enables you to process Use this parameter if your host
numbers identical document system processes at the line-item
numbers at the line-item level only. If you do not set this
level. parameter, BCI processes the
transaction, by default, at the
invoice level.
Setting this parameter is required
with the User-defined Line Item
Synchronization ID Code field when
you are processing synchronization
messages.

Batch processing parameters

In addition to the batch processing parameter that is set in the Vertex O Series install
([Link]), these parameters are for batch processing purposes:
Parameter Value Purpose
[Link] Transaction control Enables transaction control
[Link] Polling frequency Determines the number of seconds
BCI waits between processing cycles

Batch Client Interface [Link] parameters descriptions

The following topics provide detailed descriptions of [Link] parameters that are used by the
Batch Client Interface when your input is a database and your method of execution is web
service.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 8. Batch Client Interface for O Series Parameters | 211

Control table name ([Link])

This parameter setting identifies the name of the table or view that supplies control data for
batch transaction processing.
This parameter is used in conjunction with the [Link]
parameter.
Default = TransactionControl

Grouping rows of data for batch processing ([Link])

This parameter setting enables you to group rows of input data for batch transaction
processing.
This parameter is used in conjunction with the [Link] parameter.
Default = false

Ensuring that each batch-processed transaction is unique ([Link])

This parameter setting ensures that each transaction that is processed by the Batch Client
Interface is unique.
When directed to skip transactions that have already been processed, in other words, to ensure
unique transactions, the Batch Client Interface reads the input and processes records that have
a 0 or 1 as the value in Status. The Batch Client Interface then checks the Tax Journal to see if
that transaction already exists. If a record does not exist for this transaction, the Batch Client
Interface writes to the Tax Journal.
Valid values for this parameter are true and false.
Default = false
Note: Batch Client Interface does not check the Tax Journal to determine the existence of a
transaction.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 8. Batch Client Interface for O Series Parameters | 212

Enable processing of identical document numbers ([Link])

This parameter enables you to process identical document numbers at the line-item level. Use
this parameter only if your host system processes at the line-item level.
If you do not set this parameter, the Batch Client Interface processes the transaction, by default,
at the invoice level.
Setting this parameter is required with the User-defined Line Item Synchronization ID Code field
when you are processing synchronization messages.

Setting the batch client password ([Link])

This parameter setting identifies the Batch Client Interface password for a corresponding user
for Vertex O Series authentication.
You add this parameter to the [Link] file when you run the Batch Client Interface properties
installer. You must enter either a user name and password or a trusted ID.
Default = none

Setting the batch client polling frequency ([Link])

This parameter setting defines the number of seconds that the Batch Client Interface pauses
during polling for new transactions to process.
The default time is 300 seconds (five minutes).
Default = 300
Note: If you are submitting transactions via the user interface, refer to
[Link].

Batch client input transaction table name ([Link])

This parameter setting identifies the name of the table or view that contains the input
transactions for Batch Client Interface processing.
You add this parameter to the [Link] file when you run the Batch Client Interface properties
installer.
Default = TransactionLog

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 8. Batch Client Interface for O Series Parameters | 213

Setting the batch client trusted ID ([Link])

This parameter setting identifies the Batch Client Interface trusted ID for Vertex O Series
authentication.
Each trusted ID is assigned to a specific partition.
You add this parameter to the [Link] file when you run the Batch Client Interface properties
installer. You must enter either a user name and password or a trusted ID.
You must have set the [Link] parameter to true in the [Link] file to
enable Trusted IDs.
Default = false

Setting the batch client user name ([Link])

This parameter setting identifies the Batch Client Interface user name for Vertex O Series
authentication.
You add this parameter to the [Link] file when you run the Batch Client Interface properties
installer. You must enter either a user name and password or a trusted ID.
Default = none

Setting the batch client database connection ([Link].BCI_DB)

This parameter setting defines the database connection for the Batch Client Interface. This
parameter identifies the database containing the transaction and control tables.
When you are accessing the database in the Batch Client Interface as a service, you must set this
parameter in the [Link] file.
You add this parameter to the [Link] file when you run the Batch Client Interface properties
installer.
Default = none

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 8. Batch Client Interface for O Series Parameters | 214

Running batch calculations as a web service

([Link].9#vertex-ws=[Link].batch_client.[Link]
Client)
This parameter is required in [Link] to run Batch Client Interface as a web service.
You add this parameter to the [Link] file when you run the Batch Client Interface properties
installer. When this parameter is added by the properties installer, the Batch Client Interface
utility runs automatically as a web service.
Default = none

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
Chapter 9. Exemption Certificate Management
Parameters
Set the Exemption Certificate Management parameters to determine how O Series handles
exemption certificates, resale certificates, and direct pay permits.

In this chapter
Apply limited certificate if one taxability driver is satisfied ........216
Certificate Replacement for Tax Data Import .............................216
Certificate Validation ..................................................................217
Company Logo ............................................................................217
Company Logo Alignment ..........................................................217
Hide Certificate Validation Button ..............................................218
Ignore Exemption Certificate expiration date ............................218
Max Certificate Summaries ........................................................218
Portal Certificate Approval .........................................................219
Require An Image For A Certificate ............................................219
User Signature ............................................................................220
[Link].z
[Link] .............................................................................220
[Link] ..........221
[Link] ................................................................221
[Link].............222
[Link].
use ..............................................................................................223
[Link] ..

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 9. Exemption Certificate Management Parameters | 216

Apply limited certificate if one taxability driver

is satisfied
This setting specifies whether to apply certificates with two taxability drivers assigned when at
least one of the drivers is present or only when both drivers are present.
Valid values are true and false:
• Set this setting to true to apply a certificate when at least one taxability driver is present.
• Set this setting to false to apply a certificate only when both taxability drivers are present.
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = false

Certificate Replacement for Tax Data Import

This preference enables you to control whether O Series does the following during Tax Data
Import:
• Replaces revised certificates
• Imports the Replaced indicator, which indicates if an expired certificate has a matching new
certificate.
Valid values for this preference are Enabled and Disabled.
Default = Disabled
Note: This feature is available only to users who have licensed Vertex® Exemption Certificate
ManagerTM (ECM). You cannot access this field without this license.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 9. Exemption Certificate Management Parameters | 217

Certificate Validation
This preference indicates whether the Calculation Engine validates certificates.
This validation occurs within My Enterprise, Transaction Tester, Tax Data Import, and Tax Data
Export.
Valid values for this preference are Enabled and Disabled.
Default = Enabled

Company Logo
This preference indicates the source file that contains the company logo for Certificate
Management correspondence.
Valid values for this field are as follows:
• A local image file in the BMP, JPG, JPEG, or PNG format
• A URL that indicates the location of a local file
• A URL that indicates the external location of an image
The URL can be between 1 and 255 characters.
There is no default value for this preference.

Company Logo Alignment

This preference indicates the alignment of the company logo as it displays on Exemption
Certificate Management correspondence.
Valid values for this preference are center, left, and right.
Default = center

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 9. Exemption Certificate Management Parameters | 218

Hide Certificate Validation Button

This setting enables you to hide or display the certificate validation button in the Certificates
feature.
When set to true, the certificate validation button does not display on the Vertex O Series user
interface.
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = false

Ignore Exemption Certificate expiration date

This setting enables you to keep an exemption certificate active despite its having reached its
expiration date.
Possible values are true and false. Set this parameter to true to ignore the exemption
certificate expiration date. Reporting and compliance letter functionality is not affected by this
setting.
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = false

Max Certificate Summaries

This preference enables you to set a maximum number of certificates that Vertex O Series
returns when you perform a search.
The value must be set to a whole number.
Default = 1000

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 9. Exemption Certificate Management Parameters | 219

Portal Certificate Approval

This preference setting defines whether or not certificates that were created in Vertex®
Exemption Certificate Wizard (ECW) or Exemption Certificate Portal (ECP) are automatically set
to a status of Approved when they are signed and saved. The possible values for this preference
are Enabled and Disabled. The selected setting applies to all customers who license ECW or ECP
and to all the certificates that they created using those tools.
• Enabled - Completed certificates are automatically set to statuses of Approved and Not
Validated. The Calculation Engine exempts transactions that are associated to the
certificates, as soon as they are completed and saved.
• Disabled - Certificates are
automatically set to statuses of Not Approved and Not Validated.
The Calculation Engine taxes transactions that are associated to the certificates until they
are approved.
Default = Disabled

Require An Image For A Certificate

This setting defines whether or not exemption certificates can be saved without attaching an
image of the certificate.
Setting the value to true makes the certificate image a required field, and does not permit
saving the certificate without the certificate image.
Valid values for this setting are true and false.
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = false

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 9. Exemption Certificate Management Parameters | 220

User Signature
This preference indicates the source file that contains the user signature for Certificate
Management correspondence and enables you to show an image of an original signature on
certificate letters.
The signature image displays on the hardcopy letter in the location where the User Signature
field is inserted in a letter template. If the certificate letter is sent via email, the signature image
is attached to the email, rather than displaying in the body of the email.
The image file must reside in local or network file storage. File extensions that can be stored as
images include BMP, GIF, JPEG, PDF, PNG, and TIF.
There is no default value for this preference.

[Link]
[Link]
This parameter setting indicates whether or not the certificate image ZIP file used for importing
certificates to Vertex O Series contains subdirectories for each certificate image in the file.
Valid values are true and false.
Choose your setting as follows:
• Set this parameter to true when the certificate image ZIP file lists the image files without
breaking them into separate directories. Each file name must be unique. This setting helps
to expedite the import process when you are importing a large number of certificate image
files.
• Set this parameter to false when the ZIP file breaks the certificate image files into separate
subdirectories.
Default = false

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 9. Exemption Certificate Management Parameters | 221

[Link]
tFileSize
This parameter enables you to specify the maximum ZIP file size for export files that Tax Data
Export generates.
This parameter is expressed in bytes, and the default value is 2000000000 bytes (which equals
2,000 MB or 2 GB).
Default = 2000000000

[Link]
This parameter can limit a setup option when you add a new user for the Exemption Certificate
Portal (ECP).
One prompt during ECP user setup determines whether the new ECP user is a customer of an
existing Vertex O Series customer or a completely new customer:
• If you select Existing Customer, you must enter the existing Vertex O Series customer code.
• If you select New Customer, you create a new Vertex O Series customer record.
The [Link] configuration enables you to remove the New Customer option from
the setup so every new ECP user must be associated with an existing Vertex O Series customer.
You must add [Link]=true to your [Link] file to activate.
Valid values are true and false:
• When this parameter is present and set to true, all new ECP users must be associated to
existing Vertex O Series customers. You must enter an existing Vertex O Series customer
code during ECP user setup.
• When this parameter is not present or is set to false, the New Customer option displays. If
New Customer is selected during the setup of a new ECP user, Vertex O Series creates a new
customer record.
If you add or delete this parameter or change the value, restart your web server to make the
change effective.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 9. Exemption Certificate Management Parameters | 222

[Link]
dCache
This parameter determines whether all certificate data is pre-loaded into memory cache during
calculation processing.
Note: The cache refresh logic was changed in Vertex O Series 8.0 to reload only certificates that
have changed. This parameter is no longer needed to improve cache refresh performance
and may slow calculation speeds. Vertex recommends that you leave this parameter set
to its default setting of false.
Valid values are true and false.
When this parameter is set to true, Vertex O Series loads certificate data as it is needed, and
only for certificates that have changed. Setting this parameter to true improves cache refresh
speed, which may result in faster transaction processing speed if you maintain a large volume of
certificate records in your Vertex O Series data.
When this parameter is set to false, all certificates are preloaded. This may result in faster
transaction processing speed if you have relatively few certificates and caching speed is not a
concern.
If you change the value of this parameter, restart your web server to make the change effective.
Default = false

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 9. Exemption Certificate Management Parameters | 223

[Link]
[Link]
After you add it to your [Link] file, this parameter:
• Is applied only if the [Link] (see page 222)
parameter is set to true.
• Is specific to single use certificates.
• Enables you to distinguish appropriately between certificates that have similar criteria by
reading certificate details from the database rather than the cache.
For example, you may need to distinguish between the same customer's two single use
certificates that have different invoice numbers.
Valid values are true and false.
When set to true, the system:
• When the invoice number is provided, reads certificate details from the cache and from the
database
• When the invoice number is not provided, reads certificate details from the cache
When this parameter is set to false, all certificate details are read from the cache.
If you change the value of this parameter, restart your web server to make the change effective.
Default = false
Note: If this parameter and the
[Link] parameter are both set
to true, the [Link] parameter
takes precedence.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 9. Exemption Certificate Management Parameters | 224

[Link]
[Link]
After you add it to your [Link] file, this parameter:
• Is applied only if the [Link] parameter is
set to true.
• Enables you to distinguish appropriately between certificates that have similar criteria by
reading certificate details from the database rather than the cache.
For example, you may need to distinguish between the same customer's two single use
certificates that have different invoice numbers.
Valid values are true and false.
When this parameter is set to true, the system reads certificate details from the database.
When this parameter is set to false, the system reads certificate details based on the
[Link] parameter.

If you change the value of this parameter, restart your web server to make the change effective.
Default = false
Note: If this parameter and the
[Link] parameter are both
set to true, this parameter takes precedence.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
Chapter 10. Exemption Certificate Wizard
Parameters
Set the Exemption Certificate Wizard parameters to determine how Vertex® Exemption
Certificate Wizard handles exemption certificate rejection letters.

In this chapter
ECW Rejection Letter Template Name .......................................225
ECW Rejection Letter URL ..........................................................226
ECW Rejection Letter Subject .....................................................226

ECW Rejection Letter Template Name

This setting identifies the name of the user-defined certificate letter template that you create
for rejection letters. O Series automatically sends a rejection letter to the customer when you
click Reject on the Certificate Approval page in O Series to reject a certificate that the customer
created in ECW.
The template name must correspond to the text that you entered in the Name field when
creating a letter template in My Enterprise > Certificate Management > Letter Templates in
Vertex O Series.
The certificate rejection letter is automatically sent to the email address that is associated with
the ECW buyer in your system. The buyer email address can be either passed via a buyer
override or entered by the buyer on the Buyer Information page when creating a certificate. To
include your ECW seller email address in a letter template, you must enter the corresponding
taxpayer contact email in O Series.
There is no default value for this setting.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 10. Exemption Certificate Wizard Parameters | 226

ECW Rejection Letter URL

This setting identifies the URL to be inserted in certificate rejection letters when a certificate
that is created in ECW is rejected in O Series.
As the ECW seller, you identify the URL for the location on your website that authenticates the
buyer and then launches ECW in Edit mode. If you are using Exemption Certificate Portal (ECP),
enter the URL for ECP. The buyer that receives the certificate rejection letter clicks this URL to
open ECW and make corrections and changes to the certificate.
There is no default value for this setting.

ECW Rejection Letter Subject

This setting applies to Vertex® Exemption Certificate Wizard (ECW). For cases where you reject a
certificate that is created in ECW and you send a rejection letter to the buyer via email, this
setting identifies the text to be displayed in the email subject line.
Default value = Certificate Update Required

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
Chapter 11. Certificate Center Parameters
If you license Vertex Certificate Center (Certificate Center), you can configure settings to sync
information with Vertex O Series. Confirm that you are assigned a role that has permission to
change these sync settings.
1. These settings are at the partition level.
Enter:
• Client ID (see page 229)
• Client Secret (see page 230)
2. Enable Sync (see page 231).
3. These settings are at a global level. You can sync multiple partitions, but all on the same
schedule.
Review the defaults and change if needed:
• Sync Executor Count
• Sync Interval (see page 230)
• Sync Window Start Time (see page 231)
• Sync Window End Time (see page 231)

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 11. Certificate Center Parameters | 228

Configure sync
If you license Vertex Certificate Center when it is available and set up a sync with Vertex O
Series, you can override the default environment for your sync.
For example, if you want to sync Vertex O Series with a Certificate Center Development
environment, add these lines to your Vertex O Series [Link] file:
[Link] (see page 229)=dev_auth_url
[Link] (see page 229)=dev_ccc_url

The dev_auth_url and dev_cc_url represent the locations of your alternate environments. There
are no default values.
Remove these lines from the config file to resume syncing to your production environment.

In this chapter
[Link] .............................................................................229
[Link] .................................................................229
Client ID ......................................................................................229
Client Secret ...............................................................................230
Sync Interval ...............................................................................230
Sync Window Start Time ............................................................231
Sync Window End Time ..............................................................231
Enable Sync ................................................................................231

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 11. Certificate Center Parameters | 229

[Link]
Use this parameter in conjunction with [Link] to override the default
environment for your Vertex O Series sync with Certificate Center. You can modify this
parameter to sync to an alternate Certificate Center environment, such as a Development or
Testing environment.
The dev_auth_url and dev_cc_url parameters represent the locations of your alternate
environments, and both are required. There are no default values.
For example, if you want to sync Vertex O Series with a Certificate Center Development
environment, add these lines to your Vertex O Series [Link] file:
[Link]=dev_auth_url
[Link]=dev_ccc_url
Remove these lines from the config file to resume syncing to your production environment.

[Link]
Use this configuration in conjuction with [Link] (see page 229).
One of the [Link] file additions to shift the O Series-Certificate Center sync to an alternate
Certificate Center environment, such as a Development or Testing environment.
Both configurations are required:
[Link]=dev_auth_url
[Link]=dev_ccc_url

The dev_auth_url and dev_cc_url represent the locations of your alternate environments. There
are no default values.
Remove these lines from the config file to resume syncing to your production environment.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 11. Certificate Center Parameters | 230

Client ID
If you license Vertex Certificate Center when it is released and want to sync information with
Vertex O Series, enter the Client ID provided by Vertex. Also provide the value for the Client
Secret setting.

Changing this value after it is set may affect the sync between Vertex O Series and Certificate
Center.
There is no default value for this setting.

Client Secret
If you license Vertex Certificate Center when it is released and want to sync information with
Vertex O Series, enter the Client Secret provided by Vertex. Also provide the value for the Client
ID setting.

Changing this value after it is set may affect the sync between Vertex O Series and Certificate
Center.
There is no default value for this setting.

Sync Interval
If you license Vertex Certificate Center when it is released, use this setting to configure the
amount of time between sync operations. This setting works in tandem with the Enable Sync
setting, which activates the information sync with Vertex O Series.
This setting is configured at the system level, not the partition level.
The interval must be entered in this format: HH:MM:SS (hours:minutes:seconds).
Vertex recommends that you do not set the interval less than 1 minute. Shorter intervals may
cause unexpected delays.
Default = [Link] (5 minutes)

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 11. Certificate Center Parameters | 231

Sync Window Start Time

If you license Vertex Certificate Center when it is released, use this setting to configure the time
of day when sync operations start. This setting works in tandem with the Enable Sync setting,
Sync Interval setting, and Sync Window End Time setting.

This setting is configured at the system level, not the partition level.
The start time must be entered in this format: HH:MM (hours:minutes in military time, so 11pm is
23:00).
Default = 00:00
With the default Sync Window Start Time of 00:00 and End Time of 23:59, sync runs continually.

Sync Window End Time

If you license Vertex Certificate Center when it is released, use this setting to configure the time
of day when sync operations end. This setting works in tandem with the Enable Sync setting,
Sync Interval setting, and Sync Window Start Time setting.

This setting is configured at the system level, not the partition level.
Valid values for this setting are HH:MM (hours:minutes in military time, so 11pm is 23:00).
Default = 23:59
With the default Sync Window Start Time of 00:00 and End Time of 23:59, sync runs continually.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 11. Certificate Center Parameters | 232

Enable Sync
If you license Vertex Certificate Center when it is released, use this setting to enable an
information sync with Vertex O Series.
Valid values for this preference are Enabled and Disabled.
Default = Disabled

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
Chapter 12. Address Cleansing Parameters
Set Address Cleansing parameters to determine the level of address cleansing that you want.

In this chapter
How Address Cleansing works ....................................................233
Address Cleansing Licensed
([Link]) .................238
Continue If Address Cleansing Unavailable ................................239
Address Cleansing Processing Order ..........................................241
Continue If Address Fails To Cleanse ..........................................243
Retrieve Cleansed Address .........................................................244
Address Cleansing Service Timeout ............................................245
Define the Dispatch Client for Address Cleansing
([Link]) 246

How Address Cleansing works

Address Cleansing has four phases:
1. Enter your address information for your financial event.
In this example, Taxpayer BJ has an invoice with the following address:
11915 Kling Street
North Hollywood, CA 91607
2. TaxGIS calls Address Cleansing. Address Cleansing cleanses the address that you entered for
this transaction; that is, Address Cleansing returns a more precise address containing a
nine-digit ZIP code and a corrected postal city name.
11915 Kling Street
Valley Village, CA 91607-4069
3. TaxGIS assigns a Tax Area ID. An address with a nine-digit ZIP Code enables TaxGIS to assign
a more precise Tax Area ID.
Tax Area ID: 50371900
4. By providing more precise jurisdiction assignments, Address Cleansing enables more precise
tax calculations.
The applicable jurisdictions for this example are as follows:

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 12. Address Cleansing Parameters | 234

• United States (Country)

• California (State)
• Los Angeles (County)
• Los Angeles (City)
• Los Angeles Tourism Marketing District (District)
• Measure H Transactions And Use Tax (Lach) (District)
• Metropolitan Transit District (Lamt) (District)
• Transactions And Use Tax (Lama) (District)
• Transit District (Lact) (District)
• Transportation Commission (Latc) (District)
Note: Some ERP systems use Country, State, County, and ZIP Code to assign tax jurisdictions.
Address Cleansing requires the street address to return a cleansed address successfully.
Address Cleansing is not available for those ERP systems that do not use a street address
in determining a tax jurisdiction.

Why does Address Cleansing have O Series and TaxGIS parameters?

Address Cleansing uses a specific set of O Series and TaxGIS parameters. You must set both sets
of parameters for Address Cleansing.
Address lookup can occur through O Series during calculation processing and through TaxGIS
during Tax Area Lookup. If the Calculation Engine is performing a calculation and an address
lookup occurs, the O Series parameters override the TaxGIS parameters. If a Tax Area Lookup
occurs before the Calculation Engine performs a tax calculation and an address lookup occurs,
the TaxGIS parameters override the O Series parameters.
When you are using Transaction Tester on the O Series user interface, the system uses the O
Series parameters. When you are using Tax Area Lookup, Rate Lookup, or setting up a taxpayer's
physical location on the O Series user interface, the system uses TaxGIS Address Cleansing
parameters.
Note: If you select a configuration option on a Tax Area Lookup page, the setting applies to the
current Tax Area Lookup session only. If you set these options System > Administration >
Settings, the setting is permanent for all subsequent Tax Area Lookups. You must set
both O Series and TaxGIS parameters for Address Cleansing.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 12. Address Cleansing Parameters | 235

Planning for Address Cleansing

Plan how you want to use Address Cleansing in terms of the following:
• Licensing Address Cleansing
• Enabling Address Cleansing
• Processing addresses
• Defining what address to retrieve
• Retrieving cleansed addresses
• Processing path if Address Cleansing is not available
You implement the decisions that you make as follows:
• To apply a decision to only the current Tax Area Lookup session, set the corresponding
option on the applicable Tax Area Lookup page. Navigate to Tools > Tax Area Lookup.
• To apply a decision to all subsequent Tax Area Lookup sessions, set the corresponding
Address Cleansing setting on the Settings page. Navigate to System > Administration >
Settings.

Are you licensed for the Address Cleansing?

When you purchase Address Cleansing, you receive a separate license file. If you do not have a
valid license file and try to use Address Cleansing, the system displays a warning message.
On the System > Administration > Settings page, you must also have set the Use Address
Cleansing (see page 164) setting to true.
This must be the first decision in your planning process.

Is your infrastructure ready for Address Cleansing?

Before you use Address Cleansing, you must do the following:
• Make sure that your IT department knows about this before you set up Address Cleansing.
Address Cleansing, because it must execute a call out to the Vertex Data Center, can create
additional overhead.
• You may also need approval from your corporate infrastructure group for Address Cleansing
to make the calls to the Vertex Data Center.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 12. Address Cleansing Parameters | 236

Do you want to enable Address Cleansing?

If you want to enable Address Cleansing, you can implement this decision via the O Series user
interface as follows:
• Select the Address Cleansing check box on the Tax Area Lookup pages.
• Set the Use Address Cleansing (Calc Override) (see page 165)setting on the Settings page.
• Set the Use Address Cleansing (see page 164) setting on the Settings page.
If you select a configuration option on a Tax Area Lookup page, the setting applies to the current
Tax Area Lookup session only. If you set the option on the Settings page, the setting is
permanent for all subsequent tax area lookups. You must set both O Series and TaxGIS
parameters for Address Cleansing.

How do you define Address Cleansing processing order?

If you want to define Address Cleansing processing order, you can implement this decision via
the O Series user interface as follows:
• Select from the Address Cleansing Processing Order drop-down list on the Tax Area Lookup
pages. Navigate to Tools > Tax Area Lookup.
• Set the Address Cleansing Processing Order (Calc Override) (see page 242) setting on the
Settings page. Navigate to System > Administration > Settings.
• Set the Address Cleansing Processing Order (see page 241) setting on the Settings page.
Navigate to System > Administration > Settings.
If you select a configuration option on a Tax Area Lookup page, the setting applies to the current
Tax Area Lookup session only. If you set these options on the Settings page, the setting is
permanent for all subsequent tax area lookups. You must set both O Series and TaxGIS
parameters for Address Cleansing.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 12. Address Cleansing Parameters | 237

Do you want to retrieve cleansed addresses?

If you want to retrieve cleansed addresses, you can implement this decision via the O Series
user interface as follows:
• To apply a decision to only the current Tax Area Lookup session, select Full in the Retrieved
Cleansed Address drop-down list on the applicable Tax Area Lookup page. Navigate to Tools
> Tax Area Lookup.
• To apply a decision to all Tax Area Lookup sessions, set the Retrieve Cleansed Address (see
page 163) setting on the Settings page. Navigate to System > Administration > Settings.
You must set both O Series and TaxGIS parameters for Address Cleansing.

What address do you want to retrieve?

If you want to retrieve full Vertex addresses, you can implement this decision via the O Series
user interface as follows:
• To apply a decision to only the current Tax Area Lookup session, select the Retrieve Full
Vertex Addresses check box on the Tax Area Lookup pages.
• To apply a decision to all Tax Area Lookup sessions, set the Retrieve Full Vertex Addresses
(see page 158) setting.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 12. Address Cleansing Parameters | 238

Do you want the process to continue if the Address Cleansing is

unavailable?
If you want to indicate how to continue the Tax Area Lookup process if Address Cleansing is
unavailable, you can implement this decision via the O Series user interface as follows:
• Select the Continue if Address Cleansing Unavailable check box on the Tax Area Lookup
pages, which are on the Tools > Tax Area Lookup menu.
• Set the Continue If Address Cleansing Unavailable (Calc Override) (see page 240)setting on
the Settings page, which is on the System > Administration > Settings menu.
• Set the Continue If Address Cleansing Unavailable (see page 239) setting on the Settings
page, which is on the System > Administration > Settings menu.
If you select a configuration option on a Tax Area Lookup page, the setting applies to the current
Tax Area Lookup session only. If you set the option on the Settings page, the setting is
permanent for all subsequent tax area lookups. You must set both O Series and TaxGIS
parameters for Address Cleansing.

Address Cleansing Licensed

([Link]
sed)
This parameter setting indicates if Address Cleansing is licensed.
You must have purchased Address Cleansing to be licensed. Valid values for this parameter are
true and false.

Default = false

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 12. Address Cleansing Parameters | 239

Continue If Address Cleansing Unavailable

This setting indicates whether Vertex O Series performs a lookup if address cleansing is enabled
but the Address Cleansing feature is unavailable. You must have purchased this component and
be licensed to use this feature.
Valid values for this setting are true and false.
If the setting value is true and Address Cleansing is not available, a standard lookup occurs with
the original uncleansed address. Vertex O Series writes the following message to the Log file:
Address cleansing is not available. Processing continues without Address Cleansing.

If the setting value is false and Address Cleansing is not available, then the lookup fails. Vertex
O Series writes the following message to the Log file: Address cleansing is not available.
Vertex O Series ignores this setting if the Use Address Cleansing setting value is set to false.

When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = true

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 12. Address Cleansing Parameters | 240

Continue If Address Cleansing Unavailable (Calc Override)

This setting indicates how the Calculation Engine handles errors that occur during address
cleansing if address cleansing is enabled but the Address Cleansing feature is unavailable. You
must have purchased this component and be licensed to use this feature.
Valid values for this setting are Use TaxGIS Value, true, and false.
The default value of Use TaxGIS Value uses the set value for the Continue If Address Cleansing
Unavailable (see page 239) setting. Use this setting to have the Calculation Engine override the
value set for Continue If Address Cleansing Unavailable.
When the value is set to true and Address Cleansing is not available, a standard lookup occurs
with the original uncleansed address. O Series writes the following message to the Log file:
Address cleansing is not available. Processing continues without address cleansing.

When the value is set to false and Address Cleansing is not available, then the lookup fails.
Vertex O Series writes the following message to the Log file: Address cleansing is not
available.

Vertex O Series ignores this setting if the Use Address Cleansing setting value is set to false.

Default = Use TaxGIS Value

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 12. Address Cleansing Parameters | 241

Address Cleansing Processing Order

This setting defines the processing order for Address Cleansing. You must have purchased
Address Cleansing to be licensed.
Valid values for this setting are CALL_TAXGIS_FIRST and CALL_ADDRESS_CLEANSING_FIRST.

When to use CALL_TAXGIS_FIRST

Vertex recommends that you select CALL_TAXGIS_FIRST if most of your input addresses include a
valid ZIP+4. This can save a significant amount of time.
If TaxGIS is called first, then Tax Area Lookup calls TaxGIS. The system performs a tax area
lookup without cleansing the address that you entered. If the system returns only one Tax Area
ID, then normal processing continues without performing address cleansing. If TaxGIS returns
zero or multiple Tax Area IDs, the address that you entered is cleansed and the system performs
a second tax area lookup.

When to use CALL_ADDRESS_CLEANSING_FIRST

Vertex recommends that you select CALL_ADDRESS_CLEANSING_FIRST if most of your input
addresses have only a five-digit postal code. If Address Cleansing is called first, the system
cleanses the address that you entered before performing a tax area lookup.
This setting is ignored in the following scenarios:
• The Retrieve Cleansed Address setting is set to Full.
• The Use Address Cleansing setting is set to false.
Default = CALL_TAXGIS_FIRST

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 12. Address Cleansing Parameters | 242

Address Cleansing Processing Order (Calc Override)

This setting defines the order in which the Calculation Engine processes Address Cleansing. You
must have purchased Address Cleansing to be licensed.
Valid values for this setting are Use TaxGIS Value, CALL_TAXGIS_FIRST, and
CALL_ADDRESS_CLEANSING_FIRST.

The default value of Use TaxGIS Value uses the set value for the Address Cleansing Processing
Order (see page 241) setting. Use this setting to have the Calculation Engine override the set
value for Address Cleansing Processing Order.
This setting is ignored in the following scenarios:
• The Retrieve Cleansed Address (see page 163) setting value is set to Full
• The Use Address Cleansing (see page 164) setting value is set to false
Default = Use TaxGIS Value

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 12. Address Cleansing Parameters | 243

Continue If Address Fails To Cleanse

This setting indicates how the tax area lookup process proceeds if Address Cleansing cannot
cleanse an address.
Valid values are true and false.
When the value is set to false, tax area lookup stops if an address cannot be cleansed, such as
an address with an invalid street line. When the value is set to true, tax area lookup continues
with the original, uncleansed address.
When the value is set to false, Vertex recommends that you perform one of the following:
• Set the Address Cleansing Processing Order setting to CALL_ADDRESS_CLEANSING_FIRST.
• Set the Retrieve Cleansed Address to FULL.
Note: You must set the Use Address Cleansing setting to true before you set this setting.
Otherwise, Vertex O Series ignores this setting.
When the check box is selected, the value is true. When the check box is cleared, the value is
false.

Default = true

Continue If Address Fails To Cleanse (Calc Override)

This setting indicates how the Calculation Engine handles the tax area lookup process if Address
Cleansing cannot cleanse an address.
Valid values are Use TaxGIS Value, true, and false. The default value of Use TaxGIS Value uses
the set value for the Continue If Address Fails To Cleanse (see page 243) setting.
Use this setting to have the Calculation Engine override the set value for Continue If Address
Fails To Cleanse. When the setting value is false, the tax area lookup stops if an address cannot
be cleansed, such as an address with an invalid street line. When the value is set to true, the
tax area lookup continues with the original, uncleansed address.
Note: You must set the Use Address Cleansing (see page 164) setting value to true before you
set this value. Otherwise, Vertex O Series ignores this setting.
Default = Use TaxGIS Value

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 12. Address Cleansing Parameters | 244

Retrieve Cleansed Address

This setting indicates the address that a lookup returns. You must have purchased this
component and be licensed to use this feature.
Valid values for this setting are FULL and NONE.

When to use FULL

If you always want to call Address Cleansing first, set the value to FULL. Address Cleansing is
always called first and Address Cleansing returns the cleansed address. The service ignores the
value of the Address Cleansing Processing Order setting.

When to use NONE

If you want Vertex O Series to check when a TaxGIS lookup or an Address Cleansing request
occurs, set the value to NONE. The system checks the value of the Address Cleansing Processing
Order setting, which determines the sequence of each lookup. Finally, the system checks the
value of the To Retrieve Full Vertex Addresses setting to determine whether or not to return
Vertex address information. If this value is set to true, the system returns Vertex address
information. If this value is set to false, the system returns no address information.
Vertex O Series does not include standard Vertex address information in the XML response
message for a tax calculation.
Note: This setting is enabled only when the Use Address Cleansing setting is set to true.
Default = NONE

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 12. Address Cleansing Parameters | 245

Address Cleansing Service Timeout

This setting supplies a user-specified timeout for Address Cleansing.
A timeout may occur when Address Cleansing is busy processing other requests. The service
may receive the address cleansing request, but the response may take a significant amount of
time. This setting enables you to specify how long the service waits before failing the request.
The timeout is measured in seconds. Valid values for this setting are integers greater than zero.
Note: This setting displays only for Master Administrators when the Scope option is set to
System.

Default = 60

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 12. Address Cleansing Parameters | 246

Define the Dispatch Client for Address Cleansing

([Link]
tchClientClass)
This parameter setting defines the full name of the dispatch client implementation class to use
with Address Cleansing.
Vertex O Series integrates with Address Cleansing using a Web Service client. The Address
Cleansing client is written using Metro Web Service technologies.
The Metro web service technologies consist of several interfaces, such as Java API for XML Web
Services (JAX-WS) and SOAP with Attachments API for Java (SAAJ). However, the
implementation of these interfaces may be inconsistent between application servers. At times,
key functions may not be implemented and may be unsupported.
If the system default does not work, set this parameter to specify an implementation class to
use with Address Cleansing, depending on your environment.
Valid values are as follows:
• [Link], which is suggested for
Tomcat.
• [Link], which is suggested
for WebLogic.
Default = [Link]

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
Chapter 13. Performance Tuning Parameters
To obtain optimal performance from the CalculateTax Web service and the LookupTaxAreas
Web service, modify the configuration parameters, based on the available memory on any
computer where O Series is deployed and on the unique business needs of your organization.
The section describes some of the settings that Vertex recommends.

In this chapter

Java Virtual Machine .............................................................................251

Oracle database installations ................................................................251
Calculation Engine .................................................................................252
LookupTaxAreas Web service with TaxGIS ...........................................253
Improve performance by loading data only once ...............................253
Wait Time For Address Cleansing Retry ................................................254
Enable JMX monitoring technology ([Link]) .254

Java Virtual Machine

Vertex recommends using the following minimum settings on any Java Virtual Machine running
the CalculateTax Web service:
Parameter Setting
Minimum Java heap size 1024 MB
Maximum Java heap size 1024 MB

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 13. Performance Tuning Parameters | 248

Oracle database installations

Vertex recommends the following cache settings for all Oracle installations:
Parameter Setting

Oracle Buffer Cache 70 MB

oracle Redo Log Cache 1 MB

Calculation Engine
Vertex recommends the following parameter settings in [Link] to achieve peak performance
using the CalculateTax Web service:
Parameter Setting

[Link] false

[Link] true

Caution: If you set the [Link] parameter in [Link] to a logging

threshold other than the default value, you may affect performance negatively.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 13. Performance Tuning Parameters | 249

LookupTaxAreas Web service with TaxGIS

The performance achieved in a LookupTaxAreas Web service largely depends on the quality of
the input address and the TaxGIS configuration settings. For the best possible performance,
Vertex recommends the following:
• Provide either a Tax Area ID or a postal code. For US transactions, use a 9-digit ZIP+4-digit
postal code.
• Leave all TaxGIS configuration settings, with the exception of the maximum lookup cache
size, set to their default values. Faster performance can be achieved by modifying the
maximum lookup cache size parameter,
[Link]. The value of this parameter defines the
number of unique lookups that are retained in memory. Retrieving lookup results from
memory is significantly faster than retrieving the results from the database. Therefore, if
similar lookups are performed repeatedly, increase the cache size in proportion to the
number of lookups.
For more details about TaxGIS configuration parameters, refer to TaxGIS parameters (see page
142). For more details about setting caching for the Calculation Engine, refer to the
Administration Guide.

Improve performance by loading data only once

([Link].load_d
atarelease_once)
This parameter enables you to not reload TaxGIS or O Series data more often than once for
every data update.
This is useful if you have a problem with the data of a particular update and want to reload the
data. Setting this parameter to false enables you to rerun a particular update. The possible
values of this parameter are true and false.
The parameter is in the following format:
[Link].load_datarelease_once = true or false
The default value is true.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 13. Performance Tuning Parameters | 250

Wait Time For Address Cleansing Retry

This setting indicates the number of minutes that TaxGIS waits before attempting to cleanse an
address after the defined number of retries was reached for a previous Address Cleansing
request that failed.
The defined number of retries is set in the Number Of Address Cleansing Lookup Attempts
setting.
The system attempts to process Tax Area Lookups by using the original uncleansed address until
it reaches the wait time limit.
This setting applies only if the Continue If Address Cleansing Unavailable setting value is set to
true.

Valid values are any positive integer. A zero value indicates that there is no wait time between
Address Cleansing attempts.
Default = 5

Enable JMX monitoring technology

([Link])
This parameter setting enables JMX technologies to monitor O Series status.
Valid values are true and false.
Default = false

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
Chapter 14. Lightweight Directory Access
Protocol (LDAP)
Lightweight Directory Access Protocol (LDAP) is a standard communication protocol used to
access information residing in a central information directory. This directory is known as an
LDAP store. LDAP is the access protocol used to query the LDAP store for security information,
such as user passwords, and it provides authentication services to an O Series deployment.
When you verify your user name and password using the LDAP store, you need to log in only
once. LDAP protocol also includes LDAPS, which provides secure communication using a Secure
Socket Layer (SSL).

In this chapter
Why use LDAP?...........................................................................251
How to integrate LDAP with O Series .........................................252
LDAP best practices ....................................................................252
How LDAP parameters relate to the system partition and roles 253
Example: How LDAP attributes map to Vertex configuration file
parameters .................................................................................260
Required parameters for each step in LDAP implementation ....262
LDAP integration scenarios.........................................................263
LDAP parameters........................................................................270

Why use LDAP?

LDAP enables you to manage user names, passwords, and security policies through a central
location. LDAP also enables you to use Single sign-on. Single sign-on is an access control method
that enables you to log in once and gain access to the resources of multiple software systems.
After your user name and password are authenticated in one Vertex O Series container, you can
access all of the applications running in that container without additional authentication.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 14. Lightweight Directory Access Protocol (LDAP) | 252

How to integrate LDAP with O Series

You must integrate your organization's LDAP implementation with O Series by using parameters
in the [Link] file. You also must configure your application server to communicate to the
LDAP store. Each application server can have different configuration requirements. After you
integrate LDAP with O Series, you can read user data, such as user names and passwords, from
the LDAP store or from the Vertex O Series database.

LDAP best practices

You must complete LDAP implementation in your organization. Vertex recommends that you
have a staff member who is knowledgeable in managing LDAP.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 14. Lightweight Directory Access Protocol (LDAP) | 253

How LDAP parameters relate to the system

partition and roles
Note: For more information about all LDAP parameters refer to the Lightweight Directory
Access Protocol (LDAP) chapter in the Vertex Configuration Parameters Reference Guide.
Application users must be associated with only one partition and with one or more roles.

How to set the default partition and roles

Define the values in the [Link] (see page 280) and
[Link] (see page 280) parameters to set the association for an application user's
partition and role if none is specified.

How to set the attribute names within the LDAP store that are associated with the system
partition
Define the attributes within the LDAP store that are associated with the system partition in the
[Link] (see page 274) parameter. Define the attributes within the
LDAP store that are associated with one or more user roles in the [Link] (see
page 274) parameter.

How to map LDAP values to a specific partition and role name

You can map LDAP values within the LDAP store to a specific partition and role name. Define the
value within the LDAP store that you want to map to a partition by using the
[Link] (see page 279) parameter. Define the value within the LDAP store
that you want to map to a role or roles by using the [Link] (see page 280)
parameter.

How to map LDAP groups to O Series

You can create LDAP groups to selectively reference members that are already set up in the
LDAP repository and assign these members O Series roles. Map the members of LDAP groups to
O Series by using the [Link] (see page 277) parameter. Assign O Series roles to
members of a group by using the [Link] (see page 278) parameter. Assign an object
class to an LDAP group by using the [Link] (see page 277) parameter. Assign a
member object class to an LDAP group by using the [Link] (see page
278) parameter.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 14. Lightweight Directory Access Protocol (LDAP) | 254

1. Enable LDAP through the [Link] file.

Generally, a Master Administrator enables LDAP across all partitions.
Review the following example to determine how to enable LDAP functionality in O Series in the
[Link] file:
Client LDAP Example O Series application
implementation
LDAP Repository Valid values are LDAP and Set [Link] (see page
database name DBASE as follows: 272) to identify the database that you want to use
• LDAP identifies your and in what sequence you want to access it. For
LDAP repository. example, set this parameter as follows:
• DBASE identifies the [Link]=LDAP
O Series database. For more details about these parameters, refer to
How to use LDAP parameters (see page 271).

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 14. Lightweight Directory Access Protocol (LDAP) | 255

2. Map the login connections for your LDAP administrator to parameters

in the [Link] file.
Review the following example to determine how to map login connections for the LDAP
administrator to O Series in the [Link] file:
Client LDAP Example O Series application
implementation
Connection URL for ldap://localhost:389/O=ABC [Link]=
LDAP store Inc OU=XYZ Inc ldap://localhost:389/O=AB
• O identifies the parent C Inc OU=XYZ Inc
organizational units.
• OU identifies subsidiary
organizational units.
LDAP authentication Valid values are BIND and [Link]
mode COMPARISON. Mode=BIND
• In a BIND authentication, LDAP
compares the user name and
password login with the user
name and password that are
stored in the LDAP Repository.
• In a COMPARISON
authentication, O Series
authenticates the user name
and password by calling the
LDAP Repository.
LDAP Repository The user name of BJones. BJones [Link]=
manager user name manages the LDAP Repository at BJones
XYZ, Inc.
LDAP Repository The password of BJones. BJones [Link]
manager password manages the LDAP Repository at =password
XYZ, Inc.

For more details about these parameters, refer to How to use LDAP parameters (see page 271).

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 14. Lightweight Directory Access Protocol (LDAP) | 256

3. Map existing LDAP attributes for usernames and passwords in your

LDAP repository to parameters in the [Link] file.
Review the following example to determine how to map existing usernames and passwords in
your LDAP repository to parameters in the [Link] file:
Note: All of your LDAP users must be located on the same system. Also, because O Series uses
BIND authentication, no passwords are stored on O Series.
Client LDAP Example O Series Application
Implementation

User name stored in Each LDAP user is [Link]=UID

the LDAP Repository assigned a user name
identifier (UID). For
example, Tom Smith's
UID might be TSmith.
User password stored You must associate [Link]=XYZInc
in the LDAP user passwords to password
Repository. their corresponding
organizational unit in
the [Link] file. For
example, as an XYZ Inc.
employee, Tom Smith's
password reference is
XYZInc password. This
value points to the
password Tom Smith
sets at XYZ Inc.
Full user name stored Tom Smith's full name [Link]=fn
in the LDAP (fn) is Thomas. Smith. For more details on these parameters, see How to
Repository. This fn value points to use LDAP parameters (see page 271).
the full name Tom
Smith sets at XYZ Inc.

For more details on these parameters, refer to How to use LDAP parameters (see page 271).

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 14. Lightweight Directory Access Protocol (LDAP) | 257

4. Map existing LDAP attributes for Vertex-defined partitions to

parameters in the [Link] file.
Review the following example to determine how to map existing LDAP attributes for
Vertex-defined partitions to parameters in the [Link] file:
Client LDAP Example O Series application
implementation
Default partition admin is the name of [Link]=admin
name. O Series uses the default partition if [Link]=XYZInc
the default partition if you do not specify a partition
no specific partition is name.
assigned to a user. You may want to name
the default partition,
such as XYZInc
partition.
You must associate the Add the specific name [Link]=dept
specific partition name of your LDAP partition,
in LDAP to O Series. such as dept.
You can assign multiple Add a generic name to [Link]-entity
partitions for each describe each name=XYZ Inc sub-entity partition
sub-entity in your sub-entity within XYZ For example, the Sales and Marketing partitions
organization within the Inc, such as Sales or within the in XYZ Inc are:
dept partition. Marketing.
• [Link]=
XYZ Inc sales partition
• [Link].
marketing=XYZ Inc marketing
partition

For more details about these parameters, refer to How to use LDAP parameters (see page 271).

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 14. Lightweight Directory Access Protocol (LDAP) | 258

5. Map existing LDAP attributes for Vertex-defined roles to parameters in

the [Link] file.
Review the following example to determine how to map existing LDAP attributes for
Vertex-defined roles to parameters in the [Link] file:
Client LDAP Example O Series Application
Implementation
Default role name. Partition Administrator [Link]=Partition
O Series uses the is the default role Administrator
default role if no assignment in XYZ Inc.
specific role is assigned
to a user.
You must associate Add the specific name [Link]=group
each specific role of your LDAP role, such
name in LDAP to as group.
O Series.
You can assign multiple Add a generic name to [Link]-entity role
roles for each type of describe the types of name=Master Administrator
user in your users within XYZ Inc, For example, the Sales representative and
organization within the such as Sales or Marketing role in XYZ Inc is:
group role. This allows Marketing
• [Link]
you to customize representative. Representative
access for specific =Master Administrator
types of users.
• [Link]
Representative=Managing Tax
Professional

For more details on these parameters, refer to How to use LDAP parameters (see page 271).

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 14. Lightweight Directory Access Protocol (LDAP) | 259

6. Map existing LDAP attributes for Vertex-defined groups to parameters

in the [Link] file.
Review the following example to determine how to map existing LDAP attributes for
Vertex-defined groups to parameters in the [Link] file:
Client LDAP Example O Series application
implementation
Group name. O Series Admin, sales, and [Link].GRP1=admin
loads the members of dev are group [Link].GRP2=sales
a group if the group is assignments in XYZ Inc.
[Link].GRP3=dev
defined.
Group object class. You Add the specific name [Link]=groupOfNames
must associate each of your LDAP group
specific group object object class, such as
class name in LDAP to groupOfNames.
O Series.
Group member object Add the specific name [Link]=member
class. You can of your LDAP group
associate each specific member object class,
group member object such as member.
class name in LDAP to
O Series.
Group role. You can Add a generic name to [Link].GRP1.1=Master
assign multiple roles describe the types of Administrator
for each type of user in users within a group in [Link].GRP2.1=User Role
your organization XYZ Inc, such as Sales
[Link].GRP3.1=Master
within the group role. or Marketing Administrator
This enables you to representative.
customize access for [Link].GRP3.2=API User
specific types of users. In this example, O Series assigns a single role to
Use the .x index members of GRP1 and GRP2, and multiple roles to
whether assigning one members of GRP3:
role or multiple roles • All members in the group admin (GRP1)
to a group. receive the Master Administrator role.
• All members of the group sales (GRP2)
receive the User Role role.
• All members of dev (GRP3) receive the
Master Administrator role and the API
User role.

For more details about these parameters, refer to How to use LDAP parameters (see page 271).

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 14. Lightweight Directory Access Protocol (LDAP) | 260

Example: How LDAP attributes map to Vertex

configuration file parameters
There are two important considerations that make this level of indirection in LDAP work:
• The LDAP attribute must reference the corresponding Vertex configuration file LDAP
parameter. Be certain that you set both Vertex configuration file parameters that define and
map a specific attribute, particularly when setting and mapping partitions and roles.
• The key field in the LDAP repository that points to a given value is identical to the key in the
appropriate Vertex configuration parameter.
Existing values defined in your LDAP store are mapped to the appropriate Vertex configuration
file parameters that set the corresponding values in O Series. The following table shows
examples of this mapping:
You have these That were set using these Now, map your LDAP values to That sets these
values in your LDAP parameters... these values in O
LDAP store... Vertex Configuration Series...
File parameters...
Not applicable Not applicable [Link] DBASE, LDAP
Repository=DBASE, LDAP

http:www. [Link]. [Link]=http http:www.

YourLDAP connectionURL= :[Link] YourLDAP
[Link] http:[Link] [Link]
[Link]
Not applicable [Link]. [Link]= BIND
authenticationMode=BIND BIND

BJones [Link]. [Link] BJones

directoryManager. =BJones
userName=BJones
Password [Link]. [Link]= Password
forBJones directoryManager. PasswordforBJones forBJones
password=PasswordforB
Jones
uid={Vertex [Link] [Link]= Vertex user
user} .UserName=uid uid

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 14. Lightweight Directory Access Protocol (LDAP) | 261

You have these That were set using these Now, map your LDAP values to That sets these
values in your LDAP parameters... these values in O
LDAP store... Vertex Configuration Series...
File parameters...
Password for [Link]. [Link]= Password
Vertex user password= Password for Vertexuser forVertex
Password for Vertex (required if you use COMPARISION user
user authentication)
Division1 [Link]. [Link]. Division1
systemPartition=Division systemPartition=Division1
1 You must set
[Link] in
conjunction with this parameter.
Division1=A [Link]. [Link] Division1=
ccounting [Link] ounting=Partition1 Partition1
1=Accounting You must set [Link].
systemPartition in conjunction
with this parameter.
Group1 [Link]. [Link]=Group1 Group1
[Link]=Group1 You must set [Link] in
conjunction with this parameter.
Group1= [Link]. [Link]= Group 1 role
Finance [Link].Group1=Finance Managing Tax = Managing
Professional Tax
Professional
You must set
[Link] in
conjunction with this parameter.
Home1 [Link]. [Link]. Default partition
defaultsystemPartition=Hom systemPartition=admin Home1=admin
e1
Read only [Link]. [Link]=User Default role
access defaultsystemPermission= Read only
Read only access access=User

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 14. Lightweight Directory Access Protocol (LDAP) | 262

Required parameters for each step in LDAP

implementation
The LDAP parameters that you must set may vary, depending on the unique needs of your LDAP
implementation. Use the appropriate Vertex configuration file parameters to define an LDAP
attribute to O Series before you map a value to that attribute.
Review the following table to determine the minimum required parameters for each step in
your LDAP implementation.
Note: The values in the Default LDAP values column may vary, depending on the specific
terminology in your LDAP repository.
Default
Step Required parameter
LDAP values
1. Enable LDAP through the [Link] DBASE and LDAP
[Link] file.
2. Map the login connections • [Link] LDAP connection URL
for your LDAP administrator • [Link] BIND
to parameters in the Not Applicable
• [Link]
[Link] file. Not Applicable
• [Link]
3. Map existing LDAP If you want to map an existing user uid
attributes for user names and name from your LDAP repository to O userPassword
passwords in your LDAP Series, the following parameters are
repository to parameters in required:
the [Link] file. • [Link]
• [Link]
(required if you use COMPARISION
authentication)
4. Map existing LDAP If you want to map an existing LDAP Not Applicable
attributes for Vertex-defined attribute for your Vertex-defined
partitions to parameters in partitions to O Series, the following
the [Link] file. parameters are required:
• [Link]
• [Link]
.sub-entity name
• [Link]

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 14. Lightweight Directory Access Protocol (LDAP) | 263

Default
Step Required parameter
LDAP values
5. Map existing LDAP If you want to map an existing LDAP Not Applicable
attributes for Vertex-defined attribute for your Vertex-defined roles
roles to parameters in the to O Series, the following parameters
[Link] file. are required:
• [Link]
• [Link]
• [Link]
6. Map existing LDAP If you want to map an existing LDAP Not Applicable
attributes for Vertex-defined attribute for your Vertex-defined groups
groups to parameters in the to O Series, the following parameters
[Link] file. are required:
• [Link]
• [Link]
• [Link]

For more details about these parameters, refer to How to use LDAP parameters (see page 271).

LDAP integration scenarios

The complexity of LDAP integration can vary, depending on the specific needs of your
organization. Different scenarios require different LDAP configuration parameter values. Sample
scenarios for using LDAP include the following:
• Maintain the admin and sysadmin default logins
• Log in using Bind authentication to large LDAP stores
• Log in using Bind authentication to large LDAP stores without Vertex partition and role
information
• Log in using Bind authentication to the LDAP store
• Log in using Comparison authentication with the LDAP store
• Map values from the LDAP store to Vertex O Series
Note: Multiple search hierarchies are not supported in a single O Series instance.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 14. Lightweight Directory Access Protocol (LDAP) | 264

Set LDAP parameters for admin and sysadmin default logins

Set the following LDAP parameters with these values for admin and sysadmin default logins:
• [Link]=DBASE,LDAP
• [Link]=ldap://localhost:389/o=NetscapeRoot
• [Link]=COMPARISON
• [Link]=cn=Directory Manager

• [Link]=password
• [Link]=MySource
• [Link]=My Role
Note: You can also use [Link], instead of the [Link]
parameter, to specify the location of the users in the LDAP repository.
For details about these parameters, refer to LDAP parameters (see page 270).

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 14. Lightweight Directory Access Protocol (LDAP) | 265

Set LDAP parameters for log in using Bind authentication in large LDAP
stores
Set the following LDAP parameters with these values for log in using Bind authentication in large
LDAP stores:
• [Link]=LDAP
• [Link]=ldap://localhost:389/o=NetscapeRoot
• [Link]=BIND
• [Link]=cn={0}
• [Link]=cn=Directory Manager

• [Link]=password
• [Link]=MySource
• [Link]=My Role
• [Link]=cn
• [Link]=userPassword
• [Link]=sn
• [Link]=ou=allUsers
• [Link]=vertexUsers
Note: You can also use [Link], instead of the [Link]
parameter, to specify the location of the users in the LDAP repository.
For details about these parameters, refer to LDAP parameters (see page 270).

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 14. Lightweight Directory Access Protocol (LDAP) | 266

Set LDAP parameters for log in using Bind authentication to large LDAP
stores without Vertex partition and role information
Set the following LDAP parameters with these values for login using Bind authentication to LDAP
stores without Vertex partition and role information:
• [Link]=LDAP
• [Link]=ldap://localhost:389/o=NetscapeRoot
• [Link]=BIND
• [Link]=cn={0}
• [Link]=cn=Directory Manager

• [Link]=password
• [Link]=MySource
• [Link]=My Role
• [Link]=cn
• [Link]=userPassword
• [Link]=sn
• [Link]=ou=allUsers
• [Link]=vertexUsers
• [Link]=division
• [Link]=group
Note: You can also use [Link], instead of the [Link]
parameter, to specify the location of the users in the LDAP repository.
For details about these parameters, refer to LDAP parameters (see page 270).

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 14. Lightweight Directory Access Protocol (LDAP) | 267

Set LDAP parameters for log in using Bind authentication with the LDAP
store
Set the following LDAP parameters with these values for login using Bind authentication with
the LDAP store:
• [Link]=LDAP
• [Link]=ldap://localhost:389/o=NetscapeRoot
• [Link]=BIND
• [Link]={0}
• [Link]=cn=Directory Manager

• [Link]=password
• [Link]=MySource
• [Link]=My Role
• [Link]=cn
• [Link]=userPassword
• [Link]=sn
• [Link]=ou=allUsers
Note: You can also use [Link], instead of the [Link]
parameter, to specify the location of the users in the LDAP repository.
For details about these parameters, refer to LDAP parameters (see page 270).

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 14. Lightweight Directory Access Protocol (LDAP) | 268

Set LDAP parameters for log in using Comparison authentication with the
LDAP store
Set the following LDAP parameters with these values for log in using Comparison authentication
with the LDAP store:
• [Link]=LDAP
• [Link]=ldap://localhost:389/o=NetscapeRoot
• [Link]=COMPARISON
• [Link]=cn=Directory Manager

• [Link]=password
• [Link]=MySource
• [Link]=My Role
Note: You can also use [Link], instead of the [Link]
parameter, to specify the location of the users in the LDAP repository.
For details about these parameters, refer to LDAP parameters (see page 270).

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 14. Lightweight Directory Access Protocol (LDAP) | 269

Set LDAP parameters from the LDAP store to Vertex O Series

Set the following LDAP parameters with these values from the LDAP store to Vertex O Series:
• [Link]=LDAP
• [Link]=ldap://localhost:389/o=NetscapeRoot
• [Link]=BIND
• [Link]=cn={0}
• [Link]=cn=Directory Manager

• [Link]=password
• [Link]=MySource
• [Link]=My Role
• [Link]=cn
• [Link]=userPassword
• [Link]=sn
• [Link]=ou=allUsers
• [Link]=vertexUsers
• [Link]=division
• [Link]=group
• [Link].DIVISION1=VertexPartition1
• [Link].DIVISION1=VertexPartition1
• [Link].DIVISION1=VertexPartition2
• [Link].GROUP1=VertexRole1
• [Link].GROUP2=VertexRole2
• [Link].GROUP3=VertexRole2
Note: You can also use [Link], instead of the [Link]
parameter, to specify the location of the users in the LDAP repository.
For details about these parameters, refer to LDAP parameters (see page 270).

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 14. Lightweight Directory Access Protocol (LDAP) | 270

LDAP parameters
The [Link] file parameters described in the following section are related to LDAP.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 14. Lightweight Directory Access Protocol (LDAP) | 271

How to use LDAP parameters

Review the following table to determine how to set LDAP-related parameters. For more details,
see the specific parameter descriptions in this section.
Default LDAP
Name Required?
value
[Link] Yes DBASE, LDAP
[Link] Yes localhost:389
[Link] Yes BIND
[Link] No uid={0}
(Required for BIND authentication)
[Link] Yes Not Applicable
[Link] Yes Not Applicable
[Link] Yes uid
[Link] Yes userPassword
[Link] No sn
[Link] No Not Applicable
[Link] No Not Applicable
[Link] No Not Applicable
[Link] No Not Applicable
[Link] No Not Applicable
[Link] Yes 1
[Link] No Not Applicable
[Link] No groupOfNames
[Link] No member
[Link] No Not Applicable
[Link] Yes true
[Link] No Not Applicable
[Link] No Not Applicable
[Link] Yes 11
[Link] Yes Not Applicable
[Link] No en_US

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 14. Lightweight Directory Access Protocol (LDAP) | 272

Set the repository options ([Link])

This parameter setting identifies valid repository options:

• DBASE
• LDAP
• RETAIL
This is a required setting for LDAP. If you have more than one active repository, use a
comma-separated list to set a prioritized list of options.
Default = DBASE

Set the LDAP connection URL ([Link])

This parameter setting identifies the connection URL for the LDAP store.
This is a required setting for LDAP. This value cannot be encrypted.
Note: You can also use [Link], instead of the [Link]
parameter, to specify the location of the users in the LDAP repository.
Default = localhost:389

Set the LDAP authentication mode ([Link])

This parameter setting identifies LDAP authentication mode:

• BIND: Authentication is delegated to the LDAP store.
• COMPARISION: Authentication reads the user password from the LDAP store and compares
it with the password stored within the Java code.
This is a required setting for LDAP.
Default = BIND

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 14. Lightweight Directory Access Protocol (LDAP) | 273

Set the LDAP binding service pattern ([Link])

This parameter setting defines the format used to present the security principal during LDAP
authentication mode.
This parameter is a required only for Bind authentication. The element within the braces is a
placeholder for the user name.
Note: If you used Microsoft Active Directory in your LDAP implementation, this is a required
parameter.
Default = uid={0}

Set the LDAP directory manager user name ([Link])

This parameter setting identifies the user name that the directory manager uses to access the
LDAP store.
This value may be encrypted.
Default = none

Set the LDAP directory manager password ([Link])

This parameter setting identifies the password that the directory manager uses to access the
LDAP store.
Vertex recommends that this value be encrypted.
Default = none

Set the LDAP attribute for the user name ([Link])

This parameter setting identifies the LDAP attribute for the user name.
This is a required setting for LDAP.
Default = uid

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 14. Lightweight Directory Access Protocol (LDAP) | 274

Set the LDAP attribute for the password ([Link])

This parameter setting identifies the LDAP attribute for the user password.
This is a required setting for LDAP.
Default = userPassword

Set the LDAP attribute for the full user name ([Link])

This parameter setting identifies the LDAP attribute for the full user name.
This is a required setting for LDAP.
Default = sn

Set the LDAP attribute for the locale ([Link])

This parameter setting identifies the LDAP attribute for the locale.
Default = none

Set the LDAP attribute for the system partition name

([Link])

This parameter setting identifies the LDAP attribute for the system partition name.
Default = none

Set the LDAP attribute for the user role ([Link])

This parameter setting identifies the LDAP attribute for the user role.
Default = none

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 14. Lightweight Directory Access Protocol (LDAP) | 275

Set the LDAP object class ([Link])

This parameter setting identifies the object class that you can specify to restrict the set of users
that can be loaded from the LDAP store.
Default = none

Set the LDAP sub-context ([Link])

This parameter setting identifies the sub-context from which users are read. If you do not define
a sub-context, the system reads users directly from the context defined by the connection URL.
You can also use the [Link] parameter, instead of the [Link]
parameter, to specify the location of the users in the LDAP repository.
Notes:
• Multiple search hierarchies are not supported in a single Vertex O Series instance.
• If you manage a very large number of users in the LDAP store, you may reduce the
performance of O Series.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 14. Lightweight Directory Access Protocol (LDAP) | 276

Set the LDAP search scope for directory context ([Link])

This parameter setting enables users to map users at the level in which the directory context
specifies or to include subfolders of the directory context.
Value Level Description
0 OBJECT_SCOPE Search only at the current directory context.
1 ONELEVEL_SCOPE Search for users that are contained within the directory
context.
2 SUBTREE_SCOPE Search the directory context and all levels below it.

For example:
In the LDAP structure cn=locations,ou=departments,dc=yourCompany,dc=com:
where:
[Link]=0 would enable you to search and map users to your
company.
[Link]=1 would enable you to search and map users to your
company's departments.
[Link]=2 would enable you to search and map users to all of your
company, its departments, and its locations.
Default = 1

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 14. Lightweight Directory Access Protocol (LDAP) | 277

Set the LDAP group name ([Link])

This parameter setting identifies the group name that the directory manager uses to access the
LDAP store.
This parameter contains the DN of an LDAP group containing users to load. When defined,
Vertex O Series uses this location to load users from the LDAP repository instead of the
dirContext. If there are multiple entries, then Vertex O Series loads the users from each group.
Ensure that each group name has a unique suffix identifier. The identifier can be any name.
For example:
[Link].GRP1=cn=admin,ou=HQ,c=US,dc=example,dc=com
[Link].GRP2=cn=users,ou=HQ,c=US,dc=example,dc=com
This value cannot be encrypted.
Default = none

Set the LDAP group object class ([Link])

This parameter setting contains the name of the LDAP object class that identifies LDAP groups.
Valid values are group, groupofnames, or groupofuniquenames.
The following example creates one group:
[Link]=groupOfNames
[Link].GRP1=cn=vertex,ou=HQ,c=US,dc=example,dc=com
The following example adds an additional group:
[Link]=groupOfNames
[Link].GRP1=cn=vertex,ou=HQ,c=US,dc=example,dc=com
[Link].GRP2=cn=other,ou=HQ,c=US,dc=example,dc=com
This value cannot be encrypted.
Default = groupOfNames

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 14. Lightweight Directory Access Protocol (LDAP) | 278

Set the LDAP group member object class ([Link])

This parameter contains the name of the LDAP object class that identifies LDAP group members.
Valid values are member or uniqueMember.
These examples create group members:
[Link]=groupOfNames
[Link]=member
These examples add an additional group:
[Link]=groupOfUniqueNames
[Link]=uniqueMember
This value cannot be encrypted.
Default = member

Set the LDAP group role ([Link])

This parameter setting enables users to define a role, or multiple roles, for an LDAP group.
O Series assigns the roles to all members of the group. If defined, this role overrides any roles
that are defined in the LDAP user role attribute or LDAP role mappings. The group role suffix
must match the group name suffix for proper role assignment.
The following example defines multiple roles for an LDAP group:
[Link].GRP1=cn=vertex,ou=HQ,c=US,dc=example,dc=com
[Link].GRP1.1=Master Administrator
[Link].GRP1.2=User Role
Because there can be more than one role per group, the ldap group role parameter setting
requires an index as seen in the above example.
This value cannot be encrypted.
Default = none

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 14. Lightweight Directory Access Protocol (LDAP) | 279

Set how LDAP partial result exceptions are handled

([Link])

This parameter setting controls how Vertex O Series handles LDAP partial result exceptions
when loading users.
When set to true, Vertex O Series ignores partial result exceptions and continues loading users.
When set to false, Vertex O Series stops loading users.
The following example sets the parameter to ignore partial result exceptions and continue to
load users:
[Link]=true
Default = true

Map LDAP to partitions ([Link])

This parameter setting defines one or more mappings between the values contained within the
LDAP store to the Vertex system partition names.
[Link].DIV1=Part 1
[Link].DIV2=Part 2
In this example, you defined the mapping for DIV1 and DIV2. If DIV1 or DIV2 are read by the
attribute identified in the [Link] Partition parameter, Part 1 or Part 2 are
assigned as the system partition for that user.
If you do not define any partition mappings for a value read from the LDAP store, the system
uses the value defined in [Link] (see page 280) as the default value
for the system partition name.
Default = none

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 14. Lightweight Directory Access Protocol (LDAP) | 280

Map LDAP to role names ([Link])

This parameter setting defines one or more mappings between the values contained within the
LDAP store to the Vertex role names.
[Link].GROUP1=Master Admin1
[Link].GROUP2=Master Admin2
In this example, you defined the mapping for GROUP1 and GROUP2. If GROUP1 or GROUP2 is
read by the attribute identified in the [Link] parameter, Master Admin1 or
Master Admin2 is assigned as the role for that user.
If you do not define any role mappings for a value read from the LDAP store, the system uses
the value defined in [Link] (see page 280) as the default value for the role.
Default = none

Set the default system partition ([Link])

This parameter setting identifies the default system partition name.

Default = admin

Set the LDAP Attribute for user role ([Link])

This parameter setting identifies the default user role name.

Default = none

Set the LDAP Attribute for locale ([Link])

This parameter setting identifies the default user locale.

Default = en_US

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
Chapter 15. Direct Data Movement
Direct Data Movement provides a faster path for moving large volumes of data from the O
Series Tax Journal to the Reporting database.
The Tax Journal export process normally exports data from the Tax Journal tables to flat files,
which are then imported into the Reporting database staging tables. Direct data movement
provides direct movement from the Tax Journal to the Reporting database, without the
intermediate step of exporting the data to the flat files.
You must use the same database platform for transaction processing and for reporting to use
direct data movement.

In this chapter
Direct Data Movement configuration parameters .....................282
Configuring Direct Data Movement for use with your database 282

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 15. Direct Data Movement | 282

Direct Data Movement configuration

parameters
Vertex provides these parameters to enable the direct copying of data from the Tax Journal to
the Reporting database staging tables. Set these parameters in the [Link] file:
Configuration parameter Description
[Link] Determines whether Tax Journal Export copies data directly from
the Tax Journal tables to the Reporting database staging tables, or
uses the existing Vertex ETL process that exports data through an
intermediary flat file.
The default value for this parameter is false.
[Link] Name of the database link to use when copying data directly from
the Tax Journal tables to the Reporting database staging tables. The
value of this parameter is database-specific and is described in the
following sections.
[Link] Controls the size of journal data segments as they are moved to the
staging tables in the Reporting database.
For example:
[Link]=50000
If this parameter is not added to the [Link] file, the default
segment size is 100000 records.

Configuring Direct Data Movement for use with

your database
This section describes the process of configuring O Series to use Direct Data Movement with the
database management systems supported by O Series.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 15. Direct Data Movement | 283

Oracle configuration
If you are using the Oracle database management system, find out where the Tax Journal and
Reporting databases for O Series are located and set configuration parameters as described in
the following paragraphs.
Set the configuration parameters as discussed below.
• If the Tax Journal and Reporting databases are on the same server in the same schema, set
[Link]=true.

• If the Tax Journal and Reporting databases are on the same server in different schemas:
Set [Link]=true
Create a database link from the Reporting database server to each Tax Journal database.
This can be done either through the Oracle Enterprise Manager UI (under Schema /
Database Links) or through SQL using the CREATE DATABASE LINK command.
• If the Tax Journal and Reporting databases are on different servers:
Set [Link]=true
Create a database link from each Tax Journal database server to the Reporting database
server. This can be done either through the Oracle Enterprise Manager UI (under Schema /
Database Links) or through SQL using the CREATE DATABASE LINK command.
Set [Link] to the name of the database link.

SQL Server configuration

If you are using the SQL Server database management system, find out where the Tax Journal
and Reporting databases for O Series are located and set configuration parameters as described
in the following paragraphs.
Set the configuration parameters as discussed below.
• If the Tax Journal and Reporting databases are on the same server in the same schema, set
[Link]=true

• If the Tax Journal and Reporting databases are on the same server in different schemas:
Set [Link]=true
Set [Link] to <journalDatabaseName>
• If the Tax Journal and Reporting databases are on different servers:
Set [Link]=true

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 15. Direct Data Movement | 284

Create a link from the Reporting database server to each Tax Journal database. This can be
done either through the SQL Server Management Studio UI (under Server Objects/Linked
Servers) or through SQL using the sp_addlinkedserver command.
Set [Link] to <journalServerName>.<journalDatabaseName>

DB2 configuration
If you are using the DB2 database management system, find out where the Tax Journal and
Reporting databases for O Series are located and set configuration parameters as described in
the following paragraphs.
Set the configuration parameters as discussed below.
• If the Tax Journal and Reporting databases are on the same server in the same schema, set
[Link]=true.

• If the Tax Journal and Reporting databases are on the same server in different schemas:
Set [Link]=true
Set up federated servers in the Reporting database with nicknames for each of the Tax
Journal tables. The nicknames must match the table names journal. Nicknames must be
created for the LineItem, LineItemLocation, LineItemTaxOvrflw, JournalExport and
JournalUpdExport tables. This can be done either through the DB2 Control Center UI (under
Databases / Nicknames) or through SQL.
• If the Tax Journal and Reporting databases are on different servers:
Set [Link]=true
Set up federated servers in the Reporting database with nicknames for each of the Tax
Journal tables. The nicknames must match the table names journal. Nicknames must be
created for the LineItem, LineItemLocation, LineItemTaxOvrflw, JournalExport and
JournalUpdExport tables. The nicknames you create must match the names of the staging
tables. This can be done either through the DB2 Control Center UI (under Databases /
Nicknames) or through SQL. If you are running a Microsoft Windows operating system, you
must also add the database user to the Windows domain to access the remote server.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 15. Direct Data Movement | 285

Postgres configuration
If you are using the Postgres database management system, find out where the Tax Journal and
Reporting databases for O Series are located and set configuration parameters as described
below, depending on your database setup.

If the Tax Journal and Reporting databases are on the same server in the same schema
Set the configuration parameters as described below.
Set [Link]=true

If the Tax Journal and Reporting databases are on the same server but in different schemas
1. Set the configuration parameters as described below.
 Set [Link]=true
 Set [Link]=<journalSchemaName>
2. Create a user and alter its default schema to point to the schema containing the journal
tables.
CREATE USER new_user with password 'new_password';
ALTER ROLE new_user SET search_path TO some_schema_name;
Set [Link].JOURNAL_DB={url="jdbc:postgresql://server_name:5432
/database_name",user="new_user",password="new_password",schemaName="public"}

where:
new_user is the user name

new_password is the password for the user

some_schema_name is the name of the schema containing the Tax Journal tables
Note: You will need to grant privileges and accessibility to the new user.

If the Tax Journal and Reporting databases are on the same server but in different databases,
or they are on different servers
In this scenario, create a foreign data wrapper (FDW) on the server that contains the Reporting
database.
1. Enable the postgres_fdw extension.
CREATE EXTENSION postgres_fdw;

2. Create the foreign "server" that points to the database containing the Tax Journal tables.
CREATE SERVER some_server FOREIGN DATA WRAPPER postgres_fdw
OPTIONS (host 'some_host', dbname 'some_database_name', port '5432', fetch_size
'500000');

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 15. Direct Data Movement | 286

where:
some_server is the name you want to give the foreign server

some_host identifies the host that holds the database

some_database_name is the name of the database containing the Tax Journal tables

By default, the fetch_size (the number of rows retrieved per call) is set to 100. To help
reduce network latency, the fetch_size is set to half a million. This parameter and can be
set to any number, based on how much memory is available to the server.
3. When the foreign server is created, the user or users can be mapped. The goal of this step is
to have the user connect to the remote database.
CREATE USER MAPPING FOR some_user SERVER some_server OPTIONS (user 'some_user',
password 'some_user_password');

where:
some user is the user name of the user to be mapped

some_server is the foreign server created in step 2

some_user_password the user's password.

4. Create a new schema that will hold the foreign table links.
CREATE SCHEMA some_schema_name;

5. The tables can now be linked.

IMPORT FOREIGN SCHEMA public
LIMIT TO
(journalexport,journalupdexport,lineitem,lineitemlocation,lineitemreturnsfield,line
itemtaxovrflw)
FROM SERVER some_server INTO some_schema_name;

where:
some_server is the foreign server created in step 2

some_schema_name is the foreign table schema name created in step 4

IMPORT FOREIGN SCHEMA public is the public schema name where the actual Tax Journal
tables reside, either on the other server or in the other database and should not be
changed
LIMIT TO are the names of the actual Tax Journal tables that are needed and should not
be changed
6. Set the configuration parameters as discussed below.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 15. Direct Data Movement | 287

Set [Link]=true
Set [Link] to the name of the foreign table schema created
in step 4.

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community
 Chapter 15. Direct Data Movement | 288

If you have more than one Tax Journal database

If you are using multiple Tax Journal databases, you must specify a
[Link] value for each Tax Journal database. The parameter
names must have the same suffix as the corresponding [Link].JOURNAL_DB
parameter names.
For example, if a deployment has three Tax Journal databases defined as follows:
[Link].JOURNAL_DB={url=…}
[Link].JOURNAL_DB.2={url=…}
[Link].JOURNAL_DB.3={url=…}

The corresponding parameters for specifying the link names must be defined as follows:
[Link]=<link to first journal>
[Link].2=<link to second journal>
[Link].3=<link to third journal>

For DB2, to prevent name conflicts, the nicknames created for each of the Tax Journal tables
must also include the same suffix. For the previous example, the nicknames must be defined as
follows:
Nicknames for the first journal – LineItem, LineItemLocation, LineItemTaxOvrflw

Nicknames for the second journal – LineItem2, LineItemLocation2, LineItemTaxOvrflw2

Nicknames for the third journal – LineItem3, LineItemLocation3, LineItemTaxOvrflw3

Vertex® Indirect Tax O Series® 9.0 Configuration Parameters Reference Guide Log on to Vertex Community