Payroll Classes Interface: Table Driven Method

Use the Payroll Classes Interface to create and update PENTA Payroll Classes Hourly Rates and Fringe Benefit Calculation Information using data from external applications. Information you load using this interface adds to or updates the data already stored in PENTA.

The Payroll Classes Interface has a Request Type of PC and an Interface Type of S. Data files you load must have Request Types assigned to the S Interface Type.

If PENTA is unable to load an individual row, it notes the rejected row, bypasses that set of information, and moves on to the next. PENTA creates or updates Hourly Rates and Fringe Benefit Calculation Information using the accepted rows from the file.

Payroll Classes Limitations & Restrictions

The requirements of the Payroll Classes window limit the extent to which you can maintain Hourly Rate and Calculation Information. The interface enforces items such as the following and provides warning or error messages if the file data does not comply with the window’s requirements:

  • Maximum Pay Thresholds

  • Standard Charge discontinuance

  • Changes in the number of calculation bases assigned to a fringe

  • Population of columns appropriate to the type of fringe calculation base

Payroll Classes Where to View Loaded Data

You can review interfaced data in the Payroll Classes window’s Hourly Rates block (on the Standard Charging tab) and Calculation Information block (on the Fringe Benefits tab).

Available Tables

Header Record

The following information relates to the INTR_PRCLASS_HDR table.

Column

Entry

Format

Description

Column

Entry

Format

Description

INTR_RQST_ID

Req

C! 13

The interface request value that you enter to initiate the interface process. The value must be consistent for all records PENTA should process together.

RECORD_COUNT

Req

I 10

Each batch includes a count of the Detail Records within the file. If the number in the Header Record differs from the number read by PENTA, no update occurs and PENTA rejects the entire file.

D_ORIG_DATE

Req

D

The file’s creation date.

RECORD_NUM

Opt

I 10

Do not assign this value. PENTA assigns this record number, which you can use to identify records with errors or warning messages.

USER_ID

Req

C 6

Id of the employee performing the load process. This user_id must exist in PENTA.

MODIFICATION_
DATE

Opt

D

Once the process completes, this displays the date PENTA marked the record as modified in the database. The current date is the default value.

Rate Detail Record

The following information relates to the INTR_PRCLASS_RATE table.

Column

Entry

Format

Description

Column

Entry

Format

Description

INTR_RQST_ID

Req

C! 13

The interface request value that you enter to initiate the interface process. The value must be consistent for all records PENTA should process together.

SEQ_NUM

Req

I 10

Sequence number uniquely identifying this row within interface request.

PR_CLASS_NUM

Req

I 8

Id of the Payroll Class you are updating. PENTA ensures the entry is valid. The Class # must exist in PR_CLASS.

ACTIVITY_CD

Req

C! 1

Required for all activity. Possible values are:

  • A (Add) – Adds the record to the database. PENTA provides an error message if the record already exists in the database.

  • C (Change) – Update an existing record. If the column is not updateable, PENTA records an error.

  • U (Update) – Add if the record does not exist and update if the record already exists, replacing any supplied column in the existing record.

PAY_RT_NUM

Req

I 4

Enter the number of the pay rate for which you are modifying rates.

PENTA verifies this value exists in the PAY_RT table for the file’s Payroll Class #.

D_EFF_DATE

Req

D

Enter the date the hourly pay rate becomes effective. When the Activity Code is:

  • A (Add) – PENTA adds a record to PAY_RT_HIST table and updates the PR_RT table if the date is more recent than the current record. PENTA generates an interface error if the record already exists.

  • C (Change) – PENTA changes the rates on existing records in the PAY_RT / PAY_RT_HIST tables that have the entered Effective Date to the ones supplied in the file. If no matching record exists, PENTA generates an interface error.

  • U (Update) – PENTA does the following:

  • Adds the record to the PAY_RT_HIST table if it does not exist.

  • Updates the PR_RT table if the date is more recent than the current record.

PENTA changes/updates the record in the tables if it does exist—replacing existing values with those supplied in the file.

REG_RATE

Opt

F 15.4

Regular payroll rate.

  • Where the entered PAY_RT_NUM identifies a pay rate with PAY_RT.SALARIED_CD = N, valid entries are zero and positive numbers. PENTA issues an error and rejects the record if the value is not zero or a positive number.

  • If the entered REG_RATE amount exceeds the Hourly Pay Rate Error Threshold entered in the PENTA Parameters window, PENTA issues an error and rejects the record.

  • Where the entered PAY_RT_NUM identifies a pay rate with PAY_RATE.SALARIED_CD = Y valid entry is null only. PENTA issues an error and rejects the record for all other values.

TH_RATE

Opt

F 15.4

Premium 1 payroll rate.

  • Where the entered PAY_RT_NUM identifies a pay rate with PAY_RT.SALARIED_CD = N valid entries are zero and positive numbers. PENTA issues an error and rejects the record if the value is not zero or a positive number.

  • If the entered TH_RATE exceeds the Hourly Pay Rate Error Threshold entered in the PENTA Parameters window, PENTA issues and error and rejects the record.

  • Where the entered PAY_RT_NUM identifies a pay rate with PAY_RATE.SALARIED_CD = Y valid entry is null only. PENTA issues an error and rejects the record for all other values.

Note: If this column is null and the REG_RATE column contains a value, PENTA calculates and defaults the value for this column as:
REG_RATE * 1.5

DT_RATE

Opt

F 15.4

Premium 2 payroll rate.

  • Where the entered PAY_RT_NUM identifies a pay rate with PAY_RT.SALARIED_CD = N valid entries are zero and positive numbers. PENTA issues an error and rejects the record if the value is not zero or a positive number.

  • If the entered DT_RATE exceeds the Hourly Pay Rate Error Threshold entered in the System Configuration window, PENTA issues and error and rejects the record.

  • Where the entered PAY_RT_NUM identifies a pay rate with PAY_RATE.SALARIED_CD = Y valid entry is null only. PENTA issues an error and rejects the record for all other values.

Note: If this column is null and the REG_RATE column contains a value, PENTA calculates and defaults the value for this column as:
REG_RATE * 2

REG_STD_CHRG_
RATE

Opt

F 15.4

Standard billing rate. The rate must be positive, zero, or null.

TH_STD_CHRG_RATE

Opt

F 15.4

Premium 1 billing rate. The rate must be positive, zero, or null.

Notes:

  • This can only be non-null when REG_STD_CHRG_RATE is non-null.

  • If this column is null and the REG_STD_CHRG_RATE column contains a value, PENTA calculates and defaults the value for this column as:
    REG_STD_CHRG_RATE * 1.5

DT_STD_CHRG_RATE

Opt

F 15.4

Premium 2 billing rate. The rate must be positive, zero, or null.

Notes:

  • This can only be non-null when REG_STD_CHRG_RATE is non-null.

  • If this column is null and the REG_STD_CHRG_RATE column contains a value, PENTA calculates and defaults the value for this column as:
    REG_STD_CHRG_RATE * 2

RECORD_NUM

Opt

I 10

Do not assign this value. PENTA assigns this record number, which you can use to identify records with errors or warning messages.

USER_ID

Req

C 6

Id of the employee performing the load process. This user_id must exist in PENTA.

MODIFICATION_
DATE

Opt

D

Once the process completes, this displays the date PENTA marked the record as modified in the database. The current date is the default value.

Fringe Calculation Detail Record

The following information relates to the INTR_PRCLASS_FRCAL table.

Column

Entry

Format

Description

Column

Entry

Format

Description

INTR_RQST_ID

Req

C! 13

The interface request value that you enter to initiate the interface process. The value must be consistent for all records PENTA should process together.

SEQ_NUM

Req

I 10

Sequence number uniquely identifying this row within interface request.

PR_CLASS_NUM

Req

I 8

Id of the Payroll Class you are updating. PENTA ensures the entry is valid. The Class # must exist in PR_CLASS.

ACTIVITY_CD

Req

C! 1

Required for all activity. Possible values are:

  • A (Add) – Adds the record to the database. PENTA provides an error message if the record already exists in the database.

  • C (Change) – Update an existing record. If the column is not updateable, PENTA records an error.

  • U (Update) – Add if the record does not exist and update if the record already exists, replacing any supplied column in the existing record.

FRNG_NUM

Req

I 3

Enter the number of the fringe for which you are modifying rates.

PENTA verifies the value exists in the PR_CLASS_FRNG table for the file’s Payroll Class #.

D_EFF_DATE

Req

D

The effective date.

CALC_NUM

Req

I 3

Enter the number of the Calculation Base for the record.

  • PENTA verifies the entry is valid.

  • Valid entries are those in the LOV for the Calc Base # field in the Payroll Class window’s Fringe Benefits tab.

  • PENTA issues an interface error for invalid entries.

  • Calc Base # is part of the primary key for the PR_CLASS_FRNG_HIST table, so the Activity Code / Existence editing detailed in the Effective Date column actually happens when a PENTA user edits the Calc Base # column.

  • When adding a record with Calc Base # 17 (Reimbursable FICA), PENTA generates an error if one of the following is true:

  • Another Calc Base # already exists for the Payroll Class/Fringe.

  • The Reimbursable FICA Calc Base already exists for another Fringe for the Payroll Class.

When adding a record with a Calc Base # other than the Reimbursable FICA Calc Base, PENTA generates an error if the Reimbursable FICA Calc Base already exists for the Payroll Class/Fringe.

UNIT_COST

Opt

F 12.3

If the Calc Base # you enter in CALC_NUM identifies an amount-based calculation, enter the appropriate fringe amount. (E.g., Calc Base # 15 (Amt per hour worked)) PENTA does the following:

  • Verifies the record contains an amount if the Calc Base # is amount based.

  • Issues an interface error if you enter an amount and the AMT_ALLOWED_CD in the CALC table is N for the value in CALC_NUM, or if the position contains invalid characters.

Notes:

  • You can enter an amount when CALC. AMT_ALLOWED_CD = Y.

  • PENTA requires an amount when CALC_NUM = 15.

PCT

Opt

F 8.5

If the Calc Base # entered in CALC_NUM identifies a percent-based calculation, enter the appropriate fringe percent. (For example, Calc Base # 9 (% of Reg Rate * Reg Hours)). PENTA does the following:

  • Verifies the record contains a percent if the Calc Base # is percent based.

  • Issues an interface error if a percent is entered and CALC. PCT_ALLOWED_CD is N or if the position contains invalid characters.

Notes:

  • This value cannot be negative.

  • You can enter a percentage when CALC. PCT_ALLOWED_CD = Y.

  • PENTA requires a percentage when CALC_NUM is 16 or 18.

LIMIT_HRS

Opt

F 10.3

If you need to limit the hours on which PENTA calculates the fringe, enter the maximum number of hours per pay period.

Notes:

  • PENTA only allows numeric entries.

  • PENTA issues an interface error if this position contains a value for a non-hours-based Calc Base # (CALC. MAX_ALLOWED_CD is N) or contains invalid characters.

This value cannot be negative.

ANNUAL_LIMIT_HRS

Opt

F 10.3

If you need to limit the annual (calendar year) number of hours on which PENTA calculates the fringe, enter the number of hours.

Notes:

  • PENTA only allows numeric entry.

  • PENTA issues an interface error if this position contains a value for a non-hours-based Calc Base # (CALC. MAX_ALLOWED_CD is N) or contains invalid characters.

  • This value cannot be negative.

MAX_FRNG_RATE

Opt

F 15.4

If the Calc Base # entered in CALC_NUM is 14 (Self-Adjusting Hourly Fringe) and you need to limit the hourly fringe amount paid, enter the maximum hourly amount.

Notes:

  • PENTA allows entry only when the Calc Base # is 14.

  • PENTA only allows numeric entry.

  • PENTA issues an interface error if:

  • Calc Base # is not 14 or

  • The Max Fringe per Hour contains invalid characters.

  • This value cannot be negative.

WC_RATE_LIMIT_CD

Opt

C! 1

If the record is for a fringe that should be included in the pay rate when PENTA performs the WC Rate Limit check during payroll processing, enter Y. (This applies to add to gross fringes only with Calc Bases unrelated to overtime hours and percent of overtime gross.)

  • For fringes where Add to Gross is Y and non-overtime Calc Bases, valid values are Y and N.

  • For fringes where Add to Gross is N or overtime Calc Bases, the valid value is N.

  • If null, PENTA sets the value to N.

PENTA issues an interface error if the position contains invalid characters.

RECORD_NUM

Opt

I 10

Do not assign this value. PENTA assigns this record number, which you can use to identify records with errors or warning messages.

USER_ID

Req

C 6

Id of the employee performing the load process. This user_id must exist in PENTA.

MODIFICATION_
DATE

Opt

D

Once the process completes, this displays the date PENTA marked the record as modified in the database. The current date is the default value.

Fringe Pay Rate Override Calculation Detail Record

The following information relates to the INTR_PRCLASS_FROVR table.

Column

Entry

Format

Description

Column

Entry

Format

Description

INTR_RQST_ID

Req

C! 13

The interface request value that you enter to initiate the interface process. The value must be consistent for all records PENTA should process together.

SEQ_NUM

Req

I 10

Sequence number uniquely identifying this row within interface request.

PR_CLASS_NUM

Req

I 8

Id of the Payroll Class you are updating. PENTA ensures the entry is valid. The Class # must exist in PR_CLASS.

ACTIVITY_CD

Req

C! 1

Required for all activity. Possible values are:

  • A (Add) – Adds the record to the database. PENTA provides an error message if the record already exists in the database.

  • C (Change) – Update an existing record. If the column is not updateable, PENTA records an error.

  • U (Update) – Add if the record does not exist and update if the record already exists, replacing any supplied column in the existing record.

FRNG_NUM

Req

I 3

Enter the number of the fringe for which you are modifying rates.

PENTA verifies the value exists in the PR_CLASS_FRNG table for the file’s Payroll Class #.

PAY_RT_NUM

Req

I 4

The Pay Rate # for which you are entering fringe calculation overrides. PENTA verifies the value exists in the PAY_RT table for the file’s Payroll Class #.

D_EFF_DATE

Req

D

The effective date. Must be YYYYMMDD format.

When the Activity Code is:

  • A (Add) – PENTA adds a record to PR_CLASS_FRNG_PAY_RT_OVR table. PENTA generates an interface error if the record already exists.

  • C (Change) – PENTA changes the calculation details on existing records in the PR_CLASS_FRNG_PAY_RT_OVR table with the entered Effective Date to the details supplied in the file and creates a record in PR_CLASS_FRNG_PAY_RT_AUD with the previous calculation details. PR_CLASS_NUM, FRNG_NUM, PAY_RT_NUM, D_EFF_DATE, and CALC_NUM of the interface record must all match the record being changed for the records to be considered matching. If no matching record exists, PENTA generates an interface error.

  • U (Update) – PENTA does the following:

    • Adds the record to the PR_CLASS_FRNG_PAY_RT_OVR table if it does not exist.

    • PENTA changes/updates the record in the tables if it does exist—replacing existing values with those supplied in the file.

CALC_NUM

Req

I 3

Enter the number of the Calculation Base for the record.

  • PENTA verifies the entry is valid.

  • Valid entries are those in the LOV for the Calc Base # field in the Payroll Class window’s Fringe Benefits tab.

  • PENTA issues an interface error for invalid entries.

  • Calc_NUM isconsidered during execution of the activity code-based edits detailed in the D_EFF_DATE description.

  • Pay Rate Fringe Calculation Override records with Calc Base # 17 are not permitted. When adding a record with Calc Base # 17 (Reimbursable FICA), PENTA generates an error during entry in INTR_PRCLASS_FROVR if one of the following is true:

  • Another Calc Base # already exists for the Payroll Class/Fringe.

  • The Reimbursable FICA Calc Base already exists for another Fringe for the Payroll Class.

When adding a record with a Calc Base # other than the Reimbursable FICA Calc Base, PENTA generates an error if the Reimbursable FICA Calc Base already exists for the Payroll Class/Fringe.

UNIT_COST

Opt

F 12.3

If the Calc Base # you enter in CALC_NUM identifies an amount-based calculation, enter the appropriate fringe amount (e.g., Calc Base # 15 (Amt per hour worked)). PENTA does the following:

  • Verifies the record contains an amount if the Calc Base # is amount based.

  • Issues an interface error if you enter an amount and the AMT_ALLOWED_CD in the CALC table is N for the value in CALC_NUM, or if the position contains invalid characters.

Notes:

  • You can enter an amount when CALC. AMT_ALLOWED_CD = Y.

  • PENTA requires an amount when CALC_NUM = 15.

PCT

Opt

F 8.5

If the Calc Base # entered in CALC_NUM identifies a percent-based calculation, enter the appropriate fringe percent (for example, Calc Base # 9 (% of Reg Rate * Reg Hours)). PENTA does the following:

  • Verifies the record contains a percent if the Calc Base # is percent based.

  • Issues an interface error if a percent is entered and CALC. PCT_ALLOWED_CD is N or if the position contains invalid characters.

Notes:

  • This value cannot be negative.

  • You can enter a percentage when CALC. PCT_ALLOWED_CD = Y.

  • PENTA requires a percentage when CALC_NUM is 16 or 18.

LIMIT_HRS

Opt

F 10.3

If you need to limit the hours on which PENTA calculates the fringe, enter the maximum number of hours per pay period.

Notes:

  • PENTA only allows numeric entries.

  • PENTA issues an interface error if this position contains a value for a non-hours-based Calc Base # (CALC. MAX_ALLOWED_CD is N) or contains invalid characters.

  • This value cannot be negative.

ANNUAL_LIMIT_HRS

Opt

F 10.3

If you need to limit the annual (calendar year) number of hours on which PENTA calculates the fringe, enter the number of hours.

Notes:

  • PENTA only allows numeric entry.

  • PENTA issues an interface error if this position contains a value for a non-hours-based Calc Base # (CALC. MAX_ALLOWED_CD is N) or contains invalid characters.

  • This value cannot be negative.

MAX_FRNG_RATE

Opt

F 15.4

If the Calc Base # entered in CALC_NUM is 14 (Self-Adjusting Hourly Fringe) and you need to limit the hourly fringe amount paid, enter the maximum hourly amount.

Notes:

  • PENTA allows entry only when the Calc Base # is 14.

  • PENTA only allows numeric entry.

  • PENTA issues an interface error if:

  • Calc Base # is not 14 or

  • The Max Fringe per Hour contains invalid characters.

  • This value cannot be negative.

WC_RATE_LIMIT_CD

Opt

C! 1

If the record is for a fringe that should be included in the pay rate when PENTA performs the WC Rate Limit check during payroll processing, enter Y. (This applies to add to gross fringes only with Calc Bases unrelated to overtime hours and percent of overtime gross.)

  • For fringes where Add to Gross is Y and non-overtime Calc Bases, valid values are Y and N.

  • For fringes where Add to Gross is N or overtime Calc Bases, the valid value is N.

  • If null, an adding a new record, PENTA sets the value to N. Entry is required hen modifying an existing record.

PENTA issues an interface error if the position contains invalid characters.

RETRO_FRNG_CD

Opt

C! 1

Indicates (with a Y or N) whether the pay rate fringe calculation override record is retroactive.

When this value is Y, during the interface process, PENTA selects timecards eligible for retroactive pay for the Payroll Class, Fringe Benefit #, and Effective Date and makes them available for calculating retroactive Fringe Benefit adjustments (which you do in the Retroactive Fringe Adjustments window).

If null, and adding a new record, PENTA sets the value to N. A null value will not modify existing records.

RECORD_NUM

N/A

I 10

Do not assign this value. PENTA assigns this record number, which you can use to identify records with errors or warning messages.

USER_ID

Req

C 6

Id of the employee performing the load process. This user_id must exist in PENTA.

MODIFICATION_
DATE

N/A

D

Once the process completes, this displays the current system date PENTA marked the record as modified in the database.