Monitoring eSocial Events

This topic provides an overview of eSocial event monitoring.

Page Name

Definition Name

Usage

eSocial Error Catalog Page

GPBR_ES_ERR_CAT

Define and maintain error, warning and informational messages for use in various components of the eSocial functionality.

eSocial Events Monitor Page

GPBR_ESOC_MONITOR

Monitor event statuses throughout the eSocial data reporting process.

eSocial Events Monitor - Details Page

GPBR_ESMON_DETL

View detailed event information of the selected event layout or event layout status.

Event Details Page

GPBR_ES_EVT_OCCUR

View additional information of the corresponding event.

eSocial is a complex reporting system. For companies that prepare and submit data to eSocial in high volume, it is important for them to be able to keep track of the progress of these events, identify errors that occur during the process cycle and take appropriate actions.

The eSocial Events Monitor provides users the ability to view the progress of events at each stage (or status) of the eSocial reporting cycle. Users can search for events using a number of supported search filters (by date, company, establishment, event, and status). From the search result that is returned, users can see the total number of events that are created for any given event layout, as well as the breakdown by status, which gives a general status summary of where events stand in the eSocial reporting cycle.

Errors found during the reporting cycle are recorded in the eSocial Events Monitor as well. They come from the eSocial functionality in PeopleSoft, the Brazilian government or third-party partners, and need to be addressed in a timely manner. PeopleSoft provides a setup page to define error messages and possible actions that users can take when errors are found.

To be able access the eSocial Events Monitor, users need to be associated with the HCCPGPBRA permission list through user roles. This permission list is linked to the system-delivered GP Administrator BRA user role.

Use the eSocial Error Catalog page (GPBR_ES_ERR_CAT) to define and maintain error, warning and informational messages for use in various components of the eSocial functionality.

Navigation

Set Up HCM > Product Related > Global Payroll & Absence Mgmt > eSocial BRA > Main Setup > eSocial Error Catalog

Image: eSocial Error Catalog page

This example illustrates the fields and controls on the eSocial Error Catalog page.

eSocial Error Catalog page

Field or Control

Definition
Source

Displays where in the general eSocial flow the message originates, which can be any of the batch processes, online HCM transactions, web service communications, and so on. Values are:

Government - Batch: From the eSocial environment.

Government - Event: From the eSocial environment.

Initial Loading: From the initial data loading process where driver records are created.

Mapping: From the mapping process when data from driver records is populated to staging tables.

Online: From the generation of driver records (on demand, for non-periodic events).

Process: From the generation of driver records that is performed by batch processes.

Third-Party: From a third-party system.

XML Generation: From the XML file generation process.
Owner

Indicates the party that is responsible for defining and maintaining the message definition. Values are:

Customer Maintained: Customers can modify messages that are defined by themselves.

PS Delivered/Not Maintained: PeopleSoft-delivered messages are displayed as read-only.

PS Delivered/Maintained
Error Code

Enter the error code.
Severity

Select the severity of the message. Values are:

Error

Message (for informational purposes)

Warning: Typically used for rectification and exclusion events. Warning messages are marked with Action Required on the eSocial Monitor.
Message Text

Enter the text of the message, which is displayed on event monitoring pages and reports. Keep it precise.
Description

Enter the detailed description of the message, for example, the reasons why the message is generated and ways to resolve issues caused.

Action

Select, if any, one or more actions that can be performed for the message. Values are:

Cancel the Event: Update the event to the Cancelled status. Cancelled events cannot be processed again.

Reprocess: Reprocess the event from the step where an error is found.

Restart the Event: Update the event to the Ready (RDY) status for it to be picked up for eSocial processing again.

Use the eSocial Events Monitor page (GPBR_ESOC_MONITOR) to monitor event statuses throughout the eSocial data reporting process.

Navigation

Global Payroll & Absence Mgmt > Absence and Payroll Processing > Reports > eSocial BRA > eSocial Events Monitor

Image: eSocial Events Monitor page

This example illustrates the fields and controls on the eSocial Events Monitor page.

eSocial Events Monitor page

Image: eSocial Events Monitor page showing search results

This example illustrates the eSocial Events Monitor page, displaying search results.

eSocial Events Monitor page showing search results

Search Criteria

Use this section to select at least one search criterion. Corresponding search sections and fields appear in the Select Filter Values section based on the selected search criteria.

Field or Control

Definition
Search Date By

This is the recommended search criteria. Values are:

Accrual Period. Select to search for events that occurred in the specified month and year time period.

Transaction Date. Select to search for events generated for transactions that occurred during the specified date range.
Search By

Values are:

  • Company. Select one or more companies, which are enabled in the Company Parameters Page.

  • Establishment. Select one or more company establishments that are enabled for eSocial reporting.

  • Employee ID. Select one or more employees.
Search Event by

Values are:

  • Event. Select one or more events, which are activated in the Events Setup Page.

  • Event Category. Select one or more delivered event categories.
Search Status By

The available value is Status.

Select Filter Values

Use this section to enter search values for selected search criteria.

Field or Control

Definition
Accrual Period From and Accrual Period To

Enter the accrual time period for the event search.

These fields appear if Accrual Period is selected in the Search Date By field.
Transaction Dt From (transaction date from) and Transaction Dt To (transaction date to)

Enter the transaction time period for the event search.

These fields appear if Transaction Date is selected in the Search Date By field.
Companies

Enter one or more eSocial-enabled companies for the event search.

This section appears if Company is selected in the Search By field.
Employees

Enter one or more employee IDs for the event search.

This section appears if Employee ID is selected in the Search By field.
Establishments

Enter one or more establishments of eSocial-enabled companies for the event search.

This section appears if Establishment is selected in the Search By field.
Events

Enter one or more eSocial-enabled events for the event search.

This section appears if Event is selected in the Search Event By field.
Event Category

Enter one or more event categories for the event search. Values are Basic Table, Non Periodic, Periodic, Query, and Termination.

This section appears if Event Category is selected in the Search Event By field.
Status

Enter one or more event statuses for the event search. Values are:

CANC (Cancelled): Events that are cancelled by users.

COMP (Completed): Events that are accepted by the government.

DUPL (Duplicated): Events that are duplicated.

ERRM (Error Mapping): Events that encountered error in the mapping process.

GERR (WS Return Error): Events that encountered error as reported by the web service.

GSUC (WS Return Success): Events that are submitted successfully as reported by the web service.

HOLD (On Hold): Events that are placed on hold and may require user action.

MAPP (Mapping): Events that are completed successfully in the mapping process and loaded to staging tables.

NEW (New): Newly created events in the system.

RDY (Ready): Events that are ready for the mapping process.

SMOV (Without Movement): Events created for companies that have no movement.

SUCC (Success): Events that are ready for XML output generation if selected.

XCRT (XML Create): Events that are completed successfully in the XML output generation process.

XERR (XML Error): Events that encountered errors during the XML output generation process.

XRDY (XML Ready): Events that are about have their XML outputs generated by an AE (application engine) process.

XSEN (XML Sent): Events with XML outputs that are submitted to the government.

This section appears if Status is selected in the Search Status By field.

Search Results

This section displays the search result summary.

Field or Control

Definition
Edit Search Values

Click to expand the search sections and modify search values, if necessary.

Events Total

Displays the sum of all event count for the listed company and event.

Click the number link to view the list of event items in more detail.
[Event Status columns]

Displays the event count for the listed company and event by status.

Click the number link to view the list of event items in more detail.

Use the eSocial Events Monitor - Details page (GPBR_ESMON_DETL) to view detailed event information of the selected event layout or event layout status.

Navigation

Click a number link (which can be a total event count, or status-specific event count) on the eSocial Events Monitor page.

Image: eSocial Events Monitor - Details page

This example illustrates the fields and controls on the eSocial Events Monitor - Details page.

eSocial Events Monitor - Details page

Field or Control

Definition
Event Code

Displays the event code and name of the entries listed in the grid.
Status

Displays the status of the entries listed in the grid.

This field appears if you click the number link of a particular status to view event detail.
Count

Displays the number of the event entries listed in the grid.

Events

The display of columns in this section changes slightly based on the event code, status, and the type of event count link (total or status-specific) that was clicked to access the event detail. Valid columns include, but not limited to:

  • Company

  • Company Name

  • Establishment ID

  • Empl ID (employee ID)

  • Empl Record

  • Name (employee)

  • Hire Date

  • Accrual Period

  • Set ID

  • Job Code

  • Job Code Description

  • Shift ID

  • Effective Date

  • Ini Date

  • End Date

  • Transaction Date. Displays the date the corresponding event occurred.

  • Operator ID. Displays the user who performed the transaction.

  • Last Processing Date. Displays the date and time when the last process was performed on the event.

  • Status

  • Event Status. Available to total count link only.

  • Details. Available to a number of status-specific count links only. Click to access the Event Details Page to view details of the corresponding event.

Field or Control

Definition
Select

Select one or more events for an action (already selected) to be performed. This field appears if the corresponding entry encounters an error and the error is associated with the selected action on the eSocial Error Catalog Page.
Action

Select an action to perform. This option appears for transaction entries that are in the Errors or Returned with Error status. The system performs the action on selected entries when you save the page.

If you select more than one entry and each is associated with a different error and action, all actions become available for selection.

Entries are removed from the grid after the selected action is performed successfully and that the statuses of entries are updated accordingly.

Status

Valid statuses are:

Field or Control

Definition
Pending

Indicates transactions that have eSocial events requested for them (driver transactions created).
In Progress

Indicates eSocial events that are in the mapping process.
Errors

Indicates transactions with internal errors found by eSocial processes.
Action Required

Indicates transactions with rectification or exclusion events that require user actions.

This status is common for rectification and exclusion events, which are sometimes critical and therefore require user intervention.
Awaiting Return

Indicates transactions that have the related XML files created and are waiting for a receipt number (if XML files are submitted to the government).

After XML files are generated, no user actions are allowed on this page. Administrators, however, can cancel or update the status of events in the Awaiting Return status on a different page.
Returned with Error

Indicates transactions that have errors found by the third-party system or the Brazilian government.
Successfully Completed

Indicates transactions that have been accepted and have corresponding receipt numbers.
Cancelled

Indicates transactions that are cancelled by users.

Use the Event Details page (GPBR_ES_EVT_OCCUR) to view additional information of the corresponding event.

Navigation

Click the Details link in the Events section of the eSocial Events Monitor - Details page.

This link appears if a status-specific event count is clicked on the eSocial Events Monitor page.

Image: Event Details page

This example illustrates the fields and controls on the Event Details page.

Event Details page showing error details

Original Event

This section displays information of the selected event. Information shown is slightly different depending on the status of the event.

Occurrences

If the event transaction you’re viewing is in an error status, all associated error codes are available for review in this section. These codes help identify the cause of errors that occurred, and provide useful tips to address them.

Error messages are defined on the eSocial Error Catalog Page.