EBICS Reporting Service

The EBICS Reporting service generates a PSR report with every FUL request.

The following table provides an overview of the EBICS Reporting service:

System name	EBICS Reporting Service
Graphical Process Modeler (GPM) categories	All Services
Description	This service composes Payment Status Report (PSR).
Business usage	Use this service to generate a PSR report with every FUL request. The PSR report is in an XML format and follows the ‘pain.002.001.02' schema. After the PSR report is generated successfully, it is placed in the EBICS subscriber's download mailbox.
Usage examples	Use this service for a business process that needs to generate a PSR report.
Preconfigured?	This service is preconfigured as part of the system installation.
Requires third-party files?	No
Platform availability	All supported Sterling B2B Integrator platforms.
Related services	None
Application requirements	None
Initiates business processes?	No
Invocation	This service is invoked from a business process.
Business process context considerations	You must be familiar with the internal service (workflow and business process parameters) that invoked this service. Workflow parameters are the values that were passed into the internal service. Business process parameters are the values specified in the BPML code.
Returned status values	Fatal - Nonrecoverable error Transient – Recoverable error Logic - Recoverable error Success Warning
Restrictions	Set the user token in the BPML code before invoking this service. Setting the user token in the BPML code ensures that the workflow executor has the right to insert the report into a mailbox.
Persistence level	System Default
Debug	Debugging information for this service is located in Sterling B2B Integrator. Navigate to Operations > System > Logs > EBICS and Operations > System > Logs > EBICS Server.

Output from Business Process to EBICS Reporting Service

The following table contains the parameters passed from the business process to the EBICS Reporting service:

Parameter	Description
trx_id	Required. Specify the EBICS transaction ID.

Output from EBICS Reporting Service to Business Process

The following table contains the parameter passed from the EBICS Reporting service to the business process:

Parameter	Description
EBICSReportInfo/StatusCode	Required. The status code of the result of the service. Valid values are OK and Error.

Business Process Example

The following example business process illustrates using the EBICS Reporting service to generate a PSR. The user token must be set in the BPML before invoking the service. Setting the user token in the BPML ensures that the workflow executor has the right to insert the report into a mailbox. In the EBICSreportingService operation, the output message value is generatePSRRequest.

<process name="EBICS_ReportingService">
  <sequence>
    <operation name="set user token">
      <participant name="SetUserToken"/>
      <output message="SetUserTokenMessage">
        <assign to="USER_TOKEN">admin</assign>
        <assign to="." from="*"/>
      </output>
      <input message="inmsg">
        <assign to="." from="*"/>
      </input>
    </operation>  
    <operation name="EBICSReportingService">
      <participant name="EBICSReportingService"/>
      <output message="generatePSRReport">
        <assign to="." from="*"/>
        <assign to="trx_id">xxxx</assign>
      </output>
      <input message="generatePSRReportResult">
        <assign to="." from="*"></assign>
      </input>
    </operation>
  </sequence>
</process>

PSR Reports - Examples

The following example is of a PSR report when 'GrpSts' is set to 'RJCT':

<Document xmlns="urn:iso:std:iso:20022:tech:xsd:pain.002.001.02">
  <pain.002.001.02>
    <GrpHdr>
      <MsgId>463353943D942C7E840110DA9D0494E5</MsgId>
      <CreDtTm>2009-07-07T03:29:37Z</CreDtTm>
      <InitgPty>
        <Id>
          <OrgId>
            <BIC>HOSTIDAA</BIC>
          </OrgId>
        </Id>
      </InitgPty>
    </GrpHdr>
    <OrgnlGrpInfAndSts>
      <OrgnlMsgId>O001</OrgnlMsgId>
      <OrgnlMsgNmId>pain.xxx.cfonb160.ict</OrgnlMsgNmId>
      <GrpSts>RJCT</GrpSts>
      <StsRsnInf>
        <StsRsn>
          <Cd>NARR</Cd>
        </StsRsn>
        <AddtlStsRsnInf>EBICS_INVALID_SIGNATURE_FILE_FORMAT</AddtlStsRsnInf>
      </StsRsnInf>
    </OrgnlGrpInfAndSts>
  </pain.002.001.02>
</Document>

The following example is of a PSR report when 'GrpSts' is set to 'RCVD':

<?xml version="1.0" encoding="UTF-8"?>
<Document xmlns="urn:iso:std:iso:20022:tech:xsd:pain.002.001.02">
  <pain.002.001.02>
    <GrpHdr>
      <MsgId>33F60D9949576D6AE926CF3BD6BFF0BB</MsgId>
      <CreDtTm>2009-07-07T03:29:39Z</CreDtTm>
      <InitgPty>
        <Id>
          <OrgId>
            <BIC>HOSTIDAA</BIC>
          </OrgId>
        </Id>
      </InitgPty>
    </GrpHdr>
    <OrgnlGrpInfAndSts>
      <OrgnlMsgId>O008</OrgnlMsgId>
      <OrgnlMsgNmId>pain.xxx.cfonb160.ict</OrgnlMsgNmId>
      <GrpSts>RCVD</GrpSts>
    </OrgnlGrpInfAndSts>
  </pain.002.001.02>
</Document>