Skip to main content
Skip table of contents

Customizing PEBD Codes XML

The Person Entity Data Lookup feature is customizable for both the name and the address sections of the lookup. These lists are found in an XML file named PedbCodes.xml on the web server in the XML directory:
c:/inetpub/wwwroot/PowerSchool/xml/PedbCodes.xml

Consider the following portion of a PedbCodes.xml file:

<XML>

<PEDBCODES>

<Code>

<Id>P</Id>

<Desc>Person Entity</Desc>

<Object>BT30PE.PENameMasterRules.1</Object>

 <NameLookup>

<AP>

<Contact/>

<Suffix/>

<Pe1099/>

<Tin/>

</AP>

<Ssn/>

<Contact/>

<Suffix/>

<NickName/>

<Tin/>

<PO>

<Contact/>

<Suffix/>

<NickName/>

<Tin/>

</PO>

</NameLookup>

The above code shows a description of the ID of "P," which is "Person Entity" and an object called "BT30PE.PENameMasterRules.1". Below that is a section labeled NameLookup. It is in this section that customization for the upper part of the BusinessPlus Person Entity Lookup page can be performed.

Within the NameLookup section there is a section for the AP subsystem (note the beginning <AP> and the ending </AP>). There is also a section for the PO subsystem. If we look at the AP section, the Contact, Suffix, PE1099, and TIN fields are the fields that will be displayed on the PE Lookup page. The PO subsystem would display the Contact, Suffix, Nickname and TIN fields. Any other subsystem would display the SSN, Contact, Suffix, Nickname, and TIN. If you would like to change the PE lookup page for the AP subsystem, you can edit the fields under the <AP> section. If you want to change the lookup for the PO subsystem, you edit the fields under the <PO> section.

In the example XML file above, on the lookup page for the AP subsystem, the PEDB would display the Contact field, the Suffix, the 1099 field and the TIN. The lookup page for the PO subsystem would display the Contact field, the Suffix, the Nickname and the TIN. Note that the PE ID and Name are always displayed. The address information would be the same for both AP and PO subsystems, displaying the first, second and third Address Lines as well as the City, State, ZIP and Contact fields. To modify the XML file, just add or replace the tags.

Tag

Description

<code>

This section contains specifics regarding an object that supports providing PE information. The standard BusinessPlus Person Entity object named PENameMasterRules is one such object. In the sample above, the object to control BOX is presented as PrimaryMst, for the pedb code (<id>) 1.

<Id>

This tag is used to specify the pedb codes that are configured inside a specific <code> section. There may be more than one <Id> specified per <code> section. An example of this is given in the first code section above. IDs <blank> and "P" are both used to identify standard BusinessPlus Person Entity.

<desc>

This tag is used to provide a description for the pedb code.

<Object>

This tag is used to provide the name of the object used to provide the PE type information for a specific <code>. Our PENameMasterRules object is one such object. In technical terms, this object supports the custom interface named IPeidHandler. Any object named here must support this interface, for it is through the methods on this interface that all of the code interacts with the objects configured here. Our PeNameMasterRules object knows how to get names and addresses, update names and addresses, lookup names and addresses, etc. for the PE subsystem.

<NameLookup>

This tag is used to specify the list of PENameMaster (pe_name_mstr, or PE-NAME-MSTR) properties (columns or fields) that are shown when a user requests a PE Lookup. The PE ID and Name properties are always shown, and there is no option to hide them. It is any additional properties that can be listed in this section to cause the property values to be shown in the lookup dialog. Within this section, you can list the properties that will be presented by default, or you can specify a subsystem, and within that, the properties that will be presented. To specify a subsystem, say PO, create a section inside of <NameLookup> with a tag named <PO>, list all of the properties, then close up the PO section with a </PO> tag. Refer to the sample above for an example. A list of the PENameMaster properties is included on this page.

<AddrLookup>

This tag is used to specify the list of PEAddrDetail properties that are shown when a user requests a PE Lookup. Any properties listed in this section will be presented in the address portion of the lookup dialog. There is no subsystem option as provided in the <NameLookup> section. A list of the PEAddrDetail properties is included on this page.

PENameMaster Properties

Below is a list of the available properties that can be added to the NameLookup area.

Property Name

Property Description

PE ID

Person Entity ID (always presented)

Name

Person Entity Name (always presented)

Suffix

Name Suffix

Nickname

Nick Name

SaluteCd

Salutation Code

Ssn

Social Security Number

Tin

Tax ID Number

Pe1099

Vendor 1099 flag

RaltId

Responsible Alternate ID

OwnerId

Owner ID

AffilCd

Affiliation Code

SelCd1

Select Code 1

SelCd2

Select Code 2

DueDays

Due Days for Payables

CreateDt

Record Creation Date

Contact

Contact Person

Email

Email address

Url

Homepage Url

Type

PE Type

Disc

Vendor Discount

TaxFlag

Tax Flag

BndlFlag

Bundle Flag

Rate

Vendor Rate

IdPrcCd01

Pricing Code

IdPrcCd02

Pricing Code

IdPrcCd03

Pricing Code

IdPrcCd04

Pricing Code

IdPrcCd05

Pricing Code

IdPrcCd06

Pricing Code

IdPrcCalc01

Pricing Calculation

IdPrcCalc02

Pricing Calculation

IdPrcCalc03

Pricing Calculation

IdPrcCalc04

Pricing Calculation

IdPrcCalc05

Pricing Calculation

IdPrcCalc06

Pricing Calculation

PEAddrDetail Properties

Property Name

Property Description

PE ID

Person Entity ID

Addr1

Address line 1

Addr2

Address line 2

Addr3

Address line 3

Addr4

Address line 4

City

City

StateCd

State

Zip

Zip

CountryCd

Country

PhoneCc01

Phone 1

PhoneCc02

Phone 2

PhoneCc03

Phone 3

AddrContact

Contact Person

Email

Email address

Url

Homepage URL

AddrCd

Address Code

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.