Employee Interface: Table Driven Method


Employee Interface: Table Driven Method

Use the Employee Interface to load PENTA Employee information using data from external applications. Information you load using this interface adds to or updates the data already stored in PENTA.

Data files you load must have Request Types assigned to the E Interface Type.

If PENTA is unable to load an individual row, it bypasses that set of Employee information and moves on to the next (unless you set up defaults and cross-references). It creates or updates Employees using the accepted rows from the file. It notes the rejected rows and does not load them into PENTA.

Limitations & Restrictions

The types of non-PENTA Employee entries and the extent to which you can maintain the related information are limited.

The interface accepts an Employee record without validating that all the necessary Employee sub-records are in the data file and processed. For example, a data file may contain all the personal data about an Employee but not the pay rate information. PENTA still accepts and loads the Employee information but provides a warning message to inform the user of the situation.

Where to View Loaded Data

You can review interfaced data in the Employee Payroll Information window.

Available Tables

Badge Detail Record

After interfacing employee badge data, you can review it in the Employee Payroll Information window’s Badge Information pop-up window or the Employee HR Information window’s Badges tab.

The following information relates to the INTR_HR_BADGE table.

Column

Entry

Format

Description

Column

Entry

Format

Description

INTR_RQST_ID

Req

C! 13

An 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.

EMP_ID

Key

X

Id of the employee associated with the BADGE_ID.

ACTIVITY_CD

Key

C! 1

Required for all activity. Possible values are:

  • A (Add) – If the BADGE_ID already exists, PENTA records an error.

  • C (Change) – Update an existing record. If the column cannot be updated, PENTA records an error.

  • D (Delete) – Delete the record. If the record does not exist or was not created by the interface, 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.

BADGE_ID

Req

C! 30

ID of the badge associated with the EMP_ID. You cannot assign the same BADGE_ID to multiple employees.

D_ASSIGNED_DATE

Req

D

The date the BADGE_ID was assigned to the EMP_ID.

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

This defaults as the current date. This column contains the date that the record is marked as modified in the database once the process initiates and completes.

BN Tax Detail Record

The following information relates to the INTR_HR_BNTAX 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.

EMP_ID

Key

X

The Id of the employee associated with the BN Tax Account record.

ACTIVITY_CD

Key

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.

D_EFF_DATE

Req

D

The Effective Date of the BN Tax Account assignment to the employee.

BN_TAX_ACCT_ID

Req

C! 6

The Id of the BN Tax Account assigned to the employee.

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.

Canadian Payroll Detail Record

The following information relates to the INTR_HR_CANPR 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.

EMP_ID

Key

X

The Id of the employee associated with the Canadian Payroll Record.

ACTIVITY_CD

Key

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.

D_EFF_DATE

Req

D

Identify the date the payroll parameters first apply to the Employee. PENTA selects the appropriate parameters for the check process based on this date and the check date associated with the check process.

FULL_PART_TIME_CD

Req

C! 1

Indicate (with an F for full-time or a P for part-time) whether the Employee works full or part time. The Statistics Canada Business Payrolls Survey requires some data based on this information. If Statistics Canada contacts you to participate in a payroll survey, completion is mandatory.

TAX_CALC_METHOD_CD

Req

C! 1

Indicate which tax formula to use for the tax calculation method. Available values are:

  • A (Cumulative averaging)

  • C (Commissioned only)

  • G (General tax formula)

EMPLOYMENT_PROV_CD

Req

C 4

Indicate which income tax calculation PENTA executes. An employee’s Province of Employment (Employment Province) determines a portion of income tax.

WORK_PROV_CD

Req

C 4

Enter the work province. This value determines the workers compensation province and work location-related tax province (e.g., NWT payroll tax). This value defaults on timecards, but you can override it during timecard entry for individual timecards. Note: You can only enter this value for a Canadian Payroll Employee.

LABOR_CREDIT_FED_AMT

Opt

F 15.2

Indicate the amount PENTA uses as a factor for appropriate tax calculations. Certain tax credits related to employee purchases of approved shares of capital stock in a labor-sponsored venture capital corporation reduce source deductions.

REDUCTION_IN_TAX_DED_AMT

Opt

F 15.2

Indicate the amount of authorized reductions in tax deductions for the Employee. PENTA uses this value in tax calculations.

OTHER_TAX_CREDITS_AMT

Opt

F 15.2

Indicate the amount of authorized tax credits for medical, charitable, etc. not recorded elsewhere for the Employee. PENTA uses this value in tax calculations.

EST_PENSION_DED_
AMT

Opt

F 15.2

Indicate the amount of estimated annual pension deductions for the Employee. PENTA uses this value in tax calculations. You can only access this column when the Tax Calculation Method is C (Commission Only).

EST_ALIMONY_DED_
AMT

Opt

F 15.2

Indicate the estimated annual alimony deduction amount for the Employee. PENTA uses the value in tax calculations. You can only access this column when the Tax Calculation Method is C (Commission Only).

SVP_CD

Req

C! 1

Indicates whether PENTA should calculate Statutory Vacation Pay for the Employee.

SVP_RT

Opt

F 7.4

The rate at which PENTA calculates Statutory Vacation Pay for the Employee. This rate overrides rates assigned at the Payroll Class level.

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.

Certification Detail Record

The following information relates to the INTR_HR_CERT table. After loading, you can view this information in the Employee HR Information window’s Certification tab.

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.

EMP_ID

Key

X

Employee ID. PENTA verifies this column exists in the EMPLOYEE table, and is an active employee.

ACTIVITY_CD

Key

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.

SORT_SEQ_NUM

Req

N 10

Sequence number uniquely identifying this row within interface request.

PROF_LICENSE_CD

Req

C 8

License Code.

ST_CD

Opt

C 4

State/Prov. PENTA verifies this column exists in the STATE table, and is an active Address State.

REGISTRATION_NUM

Opt

C 15

License Registration #.

D_DATE_LICENSED

Opt

D

Date Licensed.

D_EXPIR_DATE

Opt

D

Date Expired.

D_LAST_RENEWAL_DATE

Opt

D

Date Last Renewed.

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

PENTA User 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.

Compensation Detail Record

The following information relates to the INTR_HR_COMP 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 that uniquely identifies this record within an interface request.

EMP_ID

Key

X

The Id of the employee associated with the other compensation record.

ACTIVITY_CD

Key

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.

COMP_NUM

Key

I 3

PENTA validates this column against the OTHER_COMP table. If you attempt to add the same compensation number twice, PENTA issues an error.

PRMRY_INS_AMT

Opt

F 15.2

Amount of insurance coverage on the employee. This column can contain a value only if the calculation base number is 2.

SCNDRY_INS_AMT

Opt

F 15.2

Total amount of insurance coverage on the spouse and dependents.

This column can contain a value only if the calculation base number is 2. If this column has a value, it must be greater than zero and the spouse’s birth date cannot be null.

D_SCNDRY_BIRTH_
DATE

Opt

D

Required if a Secondary Insurance Amount exists; otherwise, do not enter a value.

D_EFF_DATE

Req

D

The effective date of the compensation.

D_EXPIR_DATE

Opt

D

The expiration date for the compensation. If entered, this date must be greater than the Effective Date. PENTA issues an error if it is less than or equal to the Effective Date.

AMT