RetrieveVertexGeoCodesHR

Retrieve Vertex Geo Codes

Minor Business Rule

Object Name: B0500542

Parent DLL: CHRM

Location: Client/Server

Language: C

1.Functional Description

1.1Purpose
Retrieves Geo Codes from Vertex database. Depending on parameters codes will be returned on the State, County or City level. This expands the
functionality available in B7300004 .

1.2Setup Notes and Prerequisites
Make Sure Vertex is installed and set up in OneWorld'ae

1.3Special Logic

2.Technical Specifications

2.1Parameters: D0500542 Retrieve Vertex GeoCodes HR
Data Item Data Structure DescriptionI/ORequiredNotes
STATEDESszStateOName of State
COUNszCountyOName of County
CTY1szCityOName of City
ADDZszBeginZipCodeO
ADDZszEndZipCodeO
GENLNGidCacheCursorPointerI/O
TXA1szGeoCodeO
EV02cP73GEOCalledI

2.1.1 Parameters: D0500542A - Unload Geo Code Cache
Data Item Data Structure DescriptionI/ORequiredNotes
GENLNGidCacheCursorPointerIYPointer to Cache to Terminate
EV02cTerminateCacheIYTerminate Cache or not

2.1.2 Parameters: D0500542B - Upload Geo Code Cache
Data Item Data Structure DescriptionI/ORequiredNotes
CTRszCountryIYTwo Digit Country Code - F7306
ADDSszStateIName of State
COUNszCountyIName of Country
CTY1szCityIName of City
ADDZszZipCodeI
VVCNszCountryCodeforCanadaIYFrom F7306
INT01nNumberOfRecordsRetrievedO
TXA1szGeoCodeO9-digit Geo Code
EV01cBatchModeI
EV02cMultiCountyBatchErrorO
SYszSystemCodeIY
EV02cMasterFileI
EV03cDisplaySingleGeoCodeI
EV04cP73GeoCalledI
EV05cCallP73GeoO

2.2Related Tables
Table Table Description
Vertex Database

2.3Related Business Functions
Source NameFunction Name
B0000182Initialize Environment for Vendor Business Functions

2.4Processing

Upload Geo Code Cache HR
1.0Initialize Behavior Routine

1.1Initialize Vertex Data Structure
1.2Set up the cached index

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
szCounty	COUN	char	OPT	OUTPUT
The name of a county, parish, or other political district that is necessary for the address or for tax purposes.
szCity	CTY1	char	OPT	OUTPUT
A name that indicates the city associated with the address.
szBeginZipCode	ADDZ	char	OPT	OUTPUT
The United States ZIP code or the postal code that specifies where a letter is to be routed. Attach this code to the address for delivery in other countries. This code is used as the low end value when doing Postal Code Transaction range processing.
szEndZipCode	ADDZ	char	OPT	OUTPUT
The United States ZIP code or the postal code that specifies where a letter is to be routed. Attach this code to the address for delivery in other countries. This code is used as the low end value when doing Postal Code Transaction range processing.
idCacheCursorPointer	GENLNG	ID	OPT	BOTH
General purpose ID variable.
szGeoCode	TXA1	char	OPT	OUTPUT
A code that identifies a tax or geographic area that has common tax rates and tax authorities. The system validates the code you enter against the Tax Areas table (F4008). The system uses the tax rate area in conjunction with the tax explanation code and tax rules to calculate tax and G/L distribution amounts when you create an invoice or voucher.
cP73GEOCalled	EV02	char	OPT	INPUT
An option that specifies the type of processing for an event.
szState	STATEDES	char	OPT	OUTPUT
The description for the state code. If you extract address book data from the J.D. Edwards Address Book system, the description originates in the UDC 00/S.

2.0Load key for Vertex Connection cache
3.0Fetch from Vertex according to Level (State,County,City)

3.1If records retrieved get location names
3.2If not retrieved set error
3.3Send back the geo code

Unload Geo Code Cache HR
1.0Initialize Behavior Routine
2.0Check for cache handle

2.1If handle found terminate cache if 1 passed in for terminate

Retrieve Vertex Geo Codes HR
1.0Initialize Behavior Routine
2.0Check if cache exists
3.0If cache exits

3.1Check for geo code in cache
3.2return values if in cache

Data Structure

D0500542 - Retrieve Vertex GeoCodes

Parameter Name Data Item Data Type Req/Opt I/O/Both

szCounty COUN char OPT OUTPUT

The name of a county, parish, or other political district that is necessary for the address or for tax purposes.

szCity CTY1 char OPT OUTPUT

A name that indicates the city associated with the address.

szBeginZipCode ADDZ char OPT OUTPUT

The United States ZIP code or the postal code that specifies where a letter is to be routed.  Attach this code to the address for delivery in
other countries. This code is used as the low end value when doing Postal Code Transaction range processing.

szEndZipCode ADDZ char OPT OUTPUT

The United States ZIP code or the postal code that specifies where a letter is to be routed.  Attach this code to the address for delivery in
other countries. This code is used as the low end value when doing Postal Code Transaction range processing.

idCacheCursorPointer GENLNG ID OPT BOTH

General purpose ID variable.

szGeoCode TXA1 char OPT OUTPUT

A code that identifies a tax or geographic area that has common tax rates and tax authorities. The system validates the code you enter
against the Tax Areas table (F4008). The system uses the tax rate area in conjunction with the tax explanation code and tax rules to calculate tax
and G/L distribution amounts when you create an invoice or voucher.

cP73GEOCalled EV02 char OPT INPUT

An option that specifies the type of processing for an event.

szState STATEDES char OPT OUTPUT

The description for the state code. If you extract address book data from the J.D. Edwards Address Book system, the description
originates in the UDC 00/S.

Related Functions

B0000182 Initialize Environment for Vendor Business Functions

Related Tables

None

UnloadGeoCodeCacheHR
UnloadGeoCodeCacheHR

Retrieve Vertex Geo Codes

Minor Business Rule

Object Name: B0500542

Parent DLL: CHRM

Location: Client/Server

Language: C

Data Structure

D0500542A - Unload GeoCode Cache

Parameter Name Data Item Data Type Req/Opt I/O/Both

idCacheCursorPointer GENLNG ID OPT INPUT

General purpose ID variable.

cTerminateCache EV02 char OPT INPUT

An option that specifies the type of processing for an event.

Related Functions

B0000182 Initialize Environment for Vendor Business Functions

Related Tables

None

UploadGeoCodeCacheHR
UploadGeoCodeCacheHR

Retrieve Vertex Geo Codes

Minor Business Rule

Object Name: B0500542

Parent DLL: CHRM

Location: Client/Server

Language: C

Data Structure

D0500542B - Upload GeoCode Cache

Parameter Name Data Item Data Type Req/Opt I/O/Both

szCountry CTR char REQ INPUT

A user defined code (00/CN) that identifies a country. The country code has no effect on currency conversion. The Address Book system
uses the country code for data selection and address formatting.

szState ADDS char OPT INPUT

A user defined code (00/S) that specifies the state or province. This code is usually a postal service abbreviation.

szCounty COUN char OPT INPUT

The name of a county, parish, or other political district that is necessary for the address or for tax purposes.

szCity CTY1 char OPT INPUT

A name that indicates the city associated with the address.

szZipCode ADDZ char OPT INPUT

The United States ZIP code or the postal code that specifies where a letter is to be routed.  Attach this code to the address for delivery in
other countries. This code is used as the low end value when doing Postal Code Transaction range processing.

szCountryCodeforCanada VVCN char REQ INPUT

The code used to specify Canada to the Vertex Sales and Use Tax System.

nNumberOfRecordsRetrieved INT01 integer OPT OUTPUT

Number of Days in Future to Query for Responses Due.

szGeoCode TXA1 char OPT OUTPUT

A code that identifies a tax or geographic area that has common tax rates and tax authorities. The system validates the code you enter
against the Tax Areas table (F4008). The system uses the tax rate area in conjunction with the tax explanation code and tax rules to calculate tax
and G/L distribution amounts when you create an invoice or voucher.

cBatchMode EV01 char OPT INPUT

An option that specifies the type of processing for an event.

cMultiCountyBatchError EV02 char OPT OUTPUT

An option that specifies the type of processing for an event.

szSystemCode SY char REQ INPUT

A user defined code (98/SY) that identifies a system. Valid values include: 01 Address Book 03B Accounts Receivable 04 Accounts
Payable 09 General Accounting 11 Multicurrency

cMasterFile EV02 char OPT INPUT

An option that specifies the type of processing for an event.

cDisplaySingleGeoCode EV03 char OPT INPUT

A radio button that specifies the level at which trace/track result is to be displayed.  Select the Detail to display all transactions except IB, IX,
and IZ types.  Or, select Derivative Lots Only to display only those transactions that may have created new derivative lot.

cP73GeoCalled EV04 char OPT INPUT

PeopleSoft event point processing flag 04.

cCallP73Geo EV05 char OPT OUTPUT

A flag that indicates whether automatic spell check is turned on.

Related Functions

B0000182 Initialize Environment for Vendor Business Functions

Related Tables

None

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
szCountry	CTR	char	REQ	INPUT
A user defined code (00/CN) that identifies a country. The country code has no effect on currency conversion. The Address Book system uses the country code for data selection and address formatting.
szState	ADDS	char	OPT	INPUT
A user defined code (00/S) that specifies the state or province. This code is usually a postal service abbreviation.
szCounty	COUN	char	OPT	INPUT
The name of a county, parish, or other political district that is necessary for the address or for tax purposes.
szCity	CTY1	char	OPT	INPUT
A name that indicates the city associated with the address.
szZipCode	ADDZ	char	OPT	INPUT
The United States ZIP code or the postal code that specifies where a letter is to be routed. Attach this code to the address for delivery in other countries. This code is used as the low end value when doing Postal Code Transaction range processing.
szCountryCodeforCanada	VVCN	char	REQ	INPUT
The code used to specify Canada to the Vertex Sales and Use Tax System.
nNumberOfRecordsRetrieved	INT01	integer	OPT	OUTPUT
Number of Days in Future to Query for Responses Due.
szGeoCode	TXA1	char	OPT	OUTPUT
A code that identifies a tax or geographic area that has common tax rates and tax authorities. The system validates the code you enter against the Tax Areas table (F4008). The system uses the tax rate area in conjunction with the tax explanation code and tax rules to calculate tax and G/L distribution amounts when you create an invoice or voucher.
cBatchMode	EV01	char	OPT	INPUT
An option that specifies the type of processing for an event.
cMultiCountyBatchError	EV02	char	OPT	OUTPUT
An option that specifies the type of processing for an event.
szSystemCode	SY	char	REQ	INPUT
A user defined code (98/SY) that identifies a system. Valid values include: 01 Address Book 03B Accounts Receivable 04 Accounts Payable 09 General Accounting 11 Multicurrency
cMasterFile	EV02	char	OPT	INPUT
An option that specifies the type of processing for an event.
cDisplaySingleGeoCode	EV03	char	OPT	INPUT
A radio button that specifies the level at which trace/track result is to be displayed. Select the Detail to display all transactions except IB, IX, and IZ types. Or, select Derivative Lots Only to display only those transactions that may have created new derivative lot.
cP73GeoCalled	EV04	char	OPT	INPUT
PeopleSoft event point processing flag 04.
cCallP73Geo	EV05	char	OPT	OUTPUT
A flag that indicates whether automatic spell check is turned on.