Report Service
The Report service produces a report by using a pre-defined report configuration as part of a business process.
The following table describes the Report service:
Category | Description |
---|---|
System name | ReportService |
Graphical Process Modeler (GPM) categories | All Services, System |
Description | The Report service produces a report using a pre-defined report configuration. The report is stored in process data with the document name, RPT_<ReportConfigName>.<Format>. For example, if the format is PDF and the Report Configuration name is TestConfig, then the report will be in process data under the document name "RPT_TestConfig.pdf". |
Business usage | The Report service enables you to run a report as part of a business process. |
Preconfigured? | Yes |
Requires third-party files? | No |
Platform availability | All supported Sterling B2B Integrator platforms |
Related services | None |
Application requirements | None |
Initiates business processes? | No |
Invocation | Invoked by a business process. It can be in any step of the business process. |
Business process context considerations | None |
Returned status values | Returned status values:
|
Restrictions | None |
Persistence level | System Default |
Testing considerations | To test the Report service:
Note: You need to have data in the database to get a meaningful
report.
|
Implementing the Report Service
To implement the Report service, complete
the following tasks:
- Create a Report service configuration. See Creating a Service Configuration.
- Configure the Report service. See Configuring the Report Service.
- Use the Report service in a business process.
Configuring the Report Service
To configure the Report service, you must specify field settings in the Graphical Process Modeler (GPM):
Field | Description |
---|---|
Format | The format of the report. Required. Valid values:
|
ReportConfigName | The name of the pre-existing report configuration. Required. |
Business Process Example
<Report_Svc_BP_Example>
<sequence>
<operation name="Report Service">
<participant name="ReportService"/>
<output message="Xout">
<assign to="ConfigName">my_report_configuration</assign>
<assign to="Format">HMTL</assign>
<assign to="." from="*"></assign>
</output>
<input message="Xin">
<assign to="." from="*"></assign>
</input>
</operation>
</sequence>
</Report_Svc_BP_Example>