Integrating With Vertex O Series

This chapter provides an overview of configuration tasks required to integrate PeopleSoft with the Vertex O Series tax solution and discusses how to:

Click to jump to parent topicUnderstanding PeopleSoft Integration With Vertex O Series

PeopleSoft communicates with the Vertex O Series web service through either the PeopleSoft Integration Broker or the Java Direct XML Post program. To integrate with the Vertex O Series tax solution, you must perform the following configuration steps:

Note. Only setting the connector URLs and setting up business units are required when using the Java Direct XML Post method.

  1. Set up your local integration gateway and load the gateway connectors.

    This step is not required if you are using the Java Direct XML Post connection method.

  2. Activate the TAX_INTEGRATION message channel.

    This step is not required if you are using the Java Direct XML Post connection method.

  3. Activate the following messages using the PeopleSoft Application Designer:

    See Enterprise PeopleTools 8.46 PeopleBook: PeopleSoft Application Designer

  4. Activate the following transactions on the PSFT_TAX node and set the connector URL to the appropriate Vertex endpoint:

  5. Set Vertex as the Tax Vendor on the PeopleSoft Financials/Supply Chain Installation Options page and set the appropriate Vertex options on the Tax Provider Installation page.

    See Setting Up PeopleSoft Installation Options for Vertex O Series.

    Note. When you switch from one Tax Vendor Application to another, such as switching from Vertex Q Series to O Series, any geocodes associated with address records in the PeopleSoft database must be upgraded before tax calculations can be sent to the tax vendor software. The Tax Provider Installation page will display the geocode upgrade process status. You should run the process, allow it to complete successfully, or fix any errors that occur, before proceeding.

  6. Configure Billing, Order Management, and Purchasing business units to calculate sales and use taxes through the installed tax vendor and set business-unit level tax vendor options.

    See Setting Up Third-Party Tax Solutions.

See Also

Updating Geocodes for Locations and Addresses

Click to jump to parent topicConfiguring Vertex O Series Integration

This section discusses how to:

Click to jump to top of pageClick to jump to parent topicPages Used to Configure Vertex O Series Integration

Page Name

Object Name

Navigation

Usage

Gateways

IB_GATEWAY

PeopleTools, Integration Broker, Configuration, Gateways

Define local integration gateway and load connectors.

Channel Status

APPMSGMONITOR

PeopleTools, Integration Broker, Monitor Integrations, Monitor Message, Channel Status

Activate the TAX_INTEGRATION message channel.

Node Definitions

IB_NODE

Integration Broker, Integration Setup, Node Definitions

Activate tax node transactions and set the connector URLs.

Click to jump to top of pageClick to jump to parent topicSetting Up the Integration Gateway

Access the Gateways page.

If the Connectors list is empty, click the Load Gateway Connectors button. The Integration Broker uses the HTTPTARGET connector to communicate with the Vertex web service.

See Enterprise PeopleTools 8.46 PeopleBook: PeopleSoft Integration Broker, Managing Integration Gateways

Click to jump to top of pageClick to jump to parent topicActivating the TAX_INTEGRATION Message Channel

Access the Channel Status page

Find the TAX_INTEGRATION entry in the table of message channels. If the channel status is Paused, click the RUN button to activate the channel.

Click to jump to top of pageClick to jump to parent topicConfigure PSFT_TAX Node Transactions

Access the Node Definitions page.

  1. Using Search, find and view the PSFT_TAX node.

  2. Click the Transactions tab.

  3. Click the Edit link for the DO_VERTEX_TAXCALC_REQ transaction.

  4. Set the Status of the transaction to Active.

  5. Click the Connectors tab.

  6. Set the Value field of the PrimaryURL property to the endpoint of the Vertex tax calculation request function. Typically this will be: http://HOST:PORT/vertex-ws/services/CalculateTaxDoc where HOST:PORT addresses the Vertex web service on the application server.

  7. Click Save.

  8. Click the Return to Transaction List link.

  9. Click the Edit link for the GET_VERTEX_TAXAREA_REQ transaction.

  10. Set the Status of the transaction to Active.

  11. Click the Connectors tab.

  12. Set the Value field of the PrimaryURL property to the endpoint of the Vertex tax area request function. Typically this will be: http://HOST:PORT/vertex-ws/services/LookupTaxAreasDoc where HOST:PORT addresses the Vertex web service on the application server.

  13. Click Save.

Click to jump to parent topicSetting Up PeopleSoft Installation Options for Vertex O Series

The Set Up Financials/Supply Chain, Install, Tax Provider Installation page provides the following options for Vertex O Series:

Note. To display options for Vertex O Series, Vertex must be chosen as the Tax Vendor on the Overall Installation Options page and Vertex O Series as the Vertex Tax Application on the Tax Provider Installation page.

Tax Vendor Call Options

Determines whether tax calculation transactions are sent to Vertex line by line or as an entire document. The options are:

  • Doc Level: an entire invoice or document is sent to Vertex for tax calculation.

  • Line Level: tax calculation transactions are sent to Vertex line by line.

The Doc Level option allows you to take advantage of invoice and multiline maximum tax rules in some jurisdictions, but when you choose the Doc Level option, returns and credits must be carried out by issuing a full credit and rebill. Choosing the document level option will also provide faster tax transaction processing in most situations since fewer messages are exchanged with the Vertex tax software.

The Line Level option allows more flexibility when issuing credits and returns, but prevents you from taking advantage of maximum tax rules at the invoice or multiline level. This option should be chosen when it is not an acceptable practice to issue a full invoice credit and rebill when an individual line must be credited.

Tax Vendor Call – Payables

Select how tax calculation transactions from the Accounts Payable application are sent to Vertex. Transactions from Purchasing are always sent line by line, regardless of the value in this field.

Tax Vendor Call – Sales

Select how tax calculation transactions from the Billing application are sent to Vertex. Transactions from Order Management are always sent line by line, regardless of the value in this field.

Tax Vendor Upgrade Status

Displays the status of the process run when the tax vendor application is changed. The process updates the geocodes associated with addresses in PeopleSoft.

Tax Vendor Deployment Option

Web Service is currently the only option.

Connection Method

Select the method used to exchange messages with the Vertex O series web service:

  • Integration Broker – use the PeopleSoft Integration Broker.

  • Java Direct XML Post – use the high-throughput Java utility.

Message Node Name

Set to the node setup for the exchange of messages between the PeopleSoft Integration Broker and the Vertex O Series web service. By default, the node to use is PSFT_TAX.

Tax Exemption Override Allowed

Select to allow tax exempt transactions to be sent from PeopleSoft to Vertex. If tax exemption overrides are not allowed, exemptions must be maintained within the Vertex application.

User Name

Enter the account name used to access the Vertex O Series web service.

Password

Enter the password for the account used to access the Vertex O Series web service.

Click to jump to parent topicTesting the Vertex O Series Integration

To test the Vertex O Series integration, click the Test Tax Install button on the Tax Provider Installation page. The system will send a test transaction to Vertex and should report a Geocode and nonzero tax amount. If an error message appears or the tax amount is zero, then there is a problem with the tax installation that must be corrected.