Submitting XML Outputs and Requesting Results
This topic provides an overview of how XML outputs and process results flow between PeopleSoft and eSocial systems using system-delivered web services.
|
Page Name |
Definition Name |
Usage |
|---|---|---|
|
GPBR_ES_SEND_RC |
Specify eSocial XML outputs to send to third-party systems. |
|
|
GPBR_ES_QUERY_RC |
Request XML output submission results from third-party systems. |
The transmission of eSocial data between the PeopleSoft system and the eSocial environment of the Brazilian government is handled through a partner integration or company customization (referred to as “third-party program” in this topic) that customers provide. PeopleSoft delivers web services that are responsible for sending XML outputs to and requesting submission results from this third-party program, which communicates with the eSocial environment and transmits information between both systems.
This diagram describes the process flow of submitting event outputs to the eSocial environment and sending the results back to the PeopleSoft system through a third-party program.
When XML outputs are generated for each driver sequence by the XML generation AE program, they are sent to the receiver node that the customer created for the third-party program in Integration Broker. These outputs are sent in batches, each of which can include up to 50 event outputs of the same group type (initial and basic tables, non-periodic, or periodic), or the maximum number allowed that is specified on the XML Options Page for any given company.
In order for XML outputs to be grouped into batches properly for submission, you need to define XML batch groups and subgroups on the XML Batch Group Definition Page. Subgroups allow you to further categorize events of a group type into smaller logical groupings. Then, assign each eSocial event to a batch group and subgroup on the Events Setup Page. PeopleSoft groups company’s event outputs of the same batch group and subgroup in batches for transmission.
PeopleSoft HCM Global Payroll for Brazil delivers two services to facilitate the communications between the PeopleSoft HCM and third-party programs.
GPBR_ESOCIAL_BATCH_SEND (eSocial BRA XML Batch Send)
GPBR_ESOCIAL_BATCH_GET_RESULTS (Get Events Processing Results)
Important! For these services to function properly, verify that correct values are specified in the Service Alias and Namespace fields on the Services page (IB_SERVICEDEFN), according to the web services that are provided by the third-party system.
GPBR_ESOCIAL_BATCH_SEND (eSocial BRA XML Batch Send)
PeopleSoft uses this service to send XML output batches to the third-party program that is responsible for delivering XML outputs to the government. Upon receipt of an XML batch, the third-party system returns a response message that contains the Protocol ID (generated by the third-party system) of the batch file. If the batch was not sent successfully, relevant information about the error is included in the response message instead.
It contains one synchronous service operation, GPBR_ESOCIAL_BATCH_SEND, with two messages:
GPBR_ESOCIAL_BATCH_SEND_REQ (request)
GPBR_ESOCIAL_BATCH_SEND_RES (response)
GPBR_ESOCIAL_BATCH_GET_RESULTS (Get Events Processing Results)
PeopleSoft uses this service to request the processing results of each event that was sent in any given batch.
The third-party system returns the result information in a response message. If any errors are found and the information cannot be returned, the response message includes the locations of where the errors or warnings were identified.
It contains one synchronous service operation, GPBR_ESOCIAL_BATCH_GET_RESULTS, with two messages:
GPBR_ESOCIAL_GET_RESULTS_REQ (request)
GPBR_ESOCIAL_GET_RESULTS_RES (response)
Integration Broker Setup Considerations for Transmitting eSocial Data
Note: Oracle delivers a document (in Portuguese) that provides an example of an integration configuration between PeopleSoft and third-party systems for eSocial reporting. This document is available for download on My Oracle Support (document ID 1526487.1).
Note that in these system-delivered service operations, both handlers and routings are not delivered. You need to add a new routing definition for each service operation.
Routings can be added from the Routings page of Service Operation component (navigation: ).
On the Routing Definitions page (IB_ROUTINGDEFN) of the new routing, specify the default local node as the sender node, and the node that is created for the third-party program as the receiver node.
On the Parameters page (IB_ROUTINGDEFNDOC) of the new routing, be sure to verify that correct values are specified in the External Alias fields.
In addition, make sure that these properties are added on the Connector Properties page (IB_ROUTINGDEFCON) for the LOCAL gateway and HTTPTARGET connector to generate the SOAP envelope:
Property ID: HEADER; Property Name: Content-Type
Enter the value for this property based on the third-party system configuration.
Property ID: HEADER; Property Name: sendUnCompressed
Enter the value for this property based on the third-party system configuration.
Property ID: HTTPPROPERTY; Property Name: Method
Enter the value for this property based on the third-party system configuration.
Property ID: HTTPPROPERTY; Property Name: SOAPUpContent
Enter the value for this property based on the third-party system configuration.
Property ID: PRIMARYURL; Property Name: URL
Enter the value for this property based on the third-party system configuration.
When this Integration Broker setup is completed, you can send eSocial XML outputs and request submission results on the Send Batch Process Page and Get Events Results Process Page.
Use the Send Batch Process page (GPBR_ES_SEND_RC) to specify eSocial XML outputs to send to third-party systems.
Navigation:
This example illustrates the fields and controls on the Send Batch Process page.
Run the GPBR_ES_SEND AE (application engine) process to submit XML output batches (as selected on this page) to the target third-party program using the eSocial BRA XML Batch Send service.
Field or Control |
Description |
|---|---|
Send Method |
Select the method to use to select XML outputs for submission. Values are Single and Multiple. |
Single Batch
This section displays if the Single send method is selected.
Field or Control |
Description |
|---|---|
Driver Sequence |
Enter one or more driver sequence numbers of XML outputs to be sent to the third-party system. The system creates a batch for each specified driver sequence. For example, if you enter 10 driver sequences to be sent to the third-party program using the Single method, the system creates 10 batches, one for each driver sequence. If you use the Single method, it is expected that you know the drive sequence numbers of files you want to send. Driver sequences can be obtained from the eSocial Events Monitor Page or through queries. |
Multiple Batch
This section displays if the Multiple send method is selected. Use this method to send XML outputs of specific XML batch groups and companies to third-party programs.
Field or Control |
Description |
|---|---|
Company |
Select the company of XML outputs to be sent to the third-party system. You can include more companies by adding more rows. If no company is selected, all eSocial-enabled companies are included. |
XML Batch Group |
Select one or more batch groups of XML outputs to be sent to the third-party system. |
Use the Get Events Results Process page (GPBR_ES_QUERY_RC) to request XML output submission results from third-party programs.
Navigation:
This example illustrates the fields and controls on the Get Events Results Process page.
Run the GPBR_ES_QRY AE process to request XML output submission results from the target third-party program using the Get Events Processing Results service.
Field or Control |
Description |
|---|---|
Query Method |
Select the method to use to query results. Vales are Single and Multiple. |
Single Queries
This section displays if the Single query method is selected.
Field or Control |
Description |
|---|---|
Protocol |
Enter one or more protocol IDs of XML batches of which you wish to request the submission results. |
Multiple Queries
This section displays if the Multiple query method is selected.
Field or Control |
Description |
|---|---|
Company |
Enter one or more companies to request the submission results of all their XML outputs. |