Processing Phases and Options

Global Payroll for Brazil creates eSocial events for reporting using application engine (AE) processes that are launched from run control pages. Built for initial data loading and specific event categories, these run control pages support a list of processing phases and options:

  • Prepare Data

    The Prepare Data option looks for new, modified, and deleted information, and creates driver data for it. The mapping process takes all the driver records (which are in the RDY status and do not have XML files generated for them yet) that meet the criteria listed on the run control page, and loads the processed data to staging tables. For rows that are loaded to staging tables successfully, their driver record status is updated to MAPP; for those that are not loaded successfully, their driver record status is changed to ERRM instead.

    Note:

    In the case of initial data loading, the processes first identify the information from PeopleSoft HCM-based records that meet the criteria listed on the run control pages and include references in driver and cross-reference tables, before processing the information and loading it to staging tables.

    After verifying the results, users may perform this step again if changes occur, or if issues are fixed and they need to be reflected in the data.

    For example, after performing the Prepare Data step, a user adds new job codes to the company. As each new job code is added, the system creates a new driver record. When the user performs this step again, the process identifies these new driver records and includes them.

    The Prepare Data step can be run multiple times, initially for the entire selection of events (or transactions) and companies on the run control page, and subsequently for those with changes or fixes.

    This option is selected and becomes unavailable for edit if the Reprocess option is selected. It becomes unavailable for edit if the Delete option is selected.

  • Reprocess

    Use this option to process again all pending entries (in the RDY status) that meet the criteria listed on the run control page. Users may use it occasionally, for example, when a change of parameter or data impacts all the events but a new driver record is not created to reflect the change.

    Note:

    The Reprocess option works differently for initial loading processes. When the Reprocess option is selected for loading initial basic table or employee data, the mapping process takes driver rows that are generated for initial data loading (GPBR_ORIG_ESOC equal to I), and are in the RDY, MAPP, ERRM, or XERR (error occurred in the XML generation) status, but do not have XML files generated for them yet.

    This option becomes unavailable for edit if the Delete option is selected.

  • Create XML

    If users are satisfied with the mapping process result, they can select this option to generate the XML outputs for driver data rows (in the MAPP row status) that are inserted to staging tables. When selected, the status of all driver records that meet the criteria listed on the run control page is updated to SUCC. A call is then made to invoke the XML generation application engine (AE) program (GPBR_GEN_XML) to create XML outputs for those matching data rows. After the AE process is completed, the status for each processed driver record is updated to XCRT.

    This option becomes unavailable for edit if the Delete option is selected.

    See Also Creating XML Outputs for Events

  • Skip Data in Error

    This option is available for selection if the Create XML option is selected. When Skip Data in Error is selected, the Create XML process ignores records that are in the "error" status, and continues with the creation of XML files for those that are clean. It gives users the option to generate XML files for error-free records and send files to eSocial first if they choose to do so, and work on the skipped records later.

    Note:

    (For S-1299 events) If both Create XML and Skip Data in Error options are selected for a company on the eSocial Period Controls Page, and the company happens to have calendar groups that aren’t finalized or events that aren’t submitted successfully for the specified period, no XML file will be created for that company and the selected event.

    If Skip Data in Error is not selected but Create XML is, the process stops if error is found in any data record included in the Create XML process.

    This option becomes unavailable for edit if the Delete option is selected.

  • Delete

    This option deletes the initial load data rows that were inserted in the driver, cross reference, and staging tables through the Prepare Data or Reprocess option.

    This option is available if none of the other options are selected. When the Delete option is selected, all other options are no longer editable.

    Customers choose this option if they discover that wrong setIDs were linked to companies on the SetID Group page by mistake.

  • Identify Calendars

    As the first step for generating payroll events, this option selects all calendars that match the selection criteria on the run control page. Calendar information is used in the mapping process for payroll events. In order to be used in payroll event processing for companies, calendars must be:

    • Finalized.

    • Associated with run types that are configured on the Run Types Page for the payroll events (S-1200 and S-1210).

    • Within the competency period specified on the run control page.

      For S-1200 events, employers submit detailed payroll wage types by employee and accrual month. A calendar is included if the begin date and end date of the period ID match the specified competency period.

      For S-1210 events, employers submit net payments by employee or non-employee and payment date. A calendar is included if the payment date falls within the specified competency period.

      When companies handle cash basis, vacation, termination, advance and any other off-cycle payments, it is normal that the actual payment date does not fall within the period to which the payment pertains. Therefore, it is possible to see calendars being processed in two periods, one by competency and the other by payment date. In an example where both the period ID and payment date of a payroll entry fall within the specified competency period, the system generates both S-1200 and S-1210 events; if the period ID falls outside and the payment date within the competency period, only the S-1210 event is generated.

    The Identify Calendars option is specific to S-1200 and S-1210 events. When either event is selected, the system automatically selects the other event, the Identify Calendars option, as well as the Validate Elements option. The Identify Calendars option can be processed with Validate Elements option alone, or together with other options (such as Prepare Data or Reprocess).

    If the Reprocess option is selected for S-1200 and S-1210 events, the system selects the Prepare Data option automatically.

  • Validate Elements

    This option validates if all accumulator elements (either Total Earnings or Total Deductions) that are entered on the Run Types Page are also set up on the Wage Types Table Page. Information is logged, if accumulator elements on the Run Types page cannot be found on the Wage Types Table page, or if the Wage Types Table page contains more elements than the accumulators that are defined on the Run Types page.

    The Validate Elements option is specific to S-1200 and S-1210 events. The system automatically selects this option when both events are selected on the eSocial Payroll Events page.

  • Validate Calendar and Events

    This option validates, for the competency period and companies selected on the eSocial Period Controls Page, if all associated calendar groups are in the 70 (Finalized) or 75 (Finalized with Bank) calculation status and that all events have been submitted successfully before the request to close the period can be processed. If there are calendar groups that are not finalized or events that are still awaiting receipt numbers from the government, an S-1299 event cannot be created. A PDF report with information about pending calendar groups and events is generated for company administrators to review and take actions accordingly.

    The system automatically selects this option if the Prepare Data, Reprocess or Create XML option is selected on the eSocial Period Control page.

  • Cancel Data

    This option deletes the existing mapping (driver and staging tables) for matching data rows that do not already have generated XML outputs. After the cancelation process is completed, the status of impacted rows is changed to RDY.

    The Cancel Data option does not apply to S-1200, S-1210, S-1280, S-1298, S-1299, S-2299, and S-2399 events.

  • Skip Closing Rule

    When this option is selected, the system generates the S-1299 event with an extra tag (<naoValid>), instructing the Government to skip the validation of the REGRA_VALIDA_FECHAMENTO_FOPAG rule when processing the event. Bypassing this validation reduces the processing time of the event, especially when the company has many employees and movements during the competency period.

    The Skip Closing Rule option is specific to S-1299. It becomes editable if the selected event is S-1299 and the Prepare Data option is selected on the eSocial Period Controls Page.