AFT Route Progress Event Reporting Service
The AFT Route Progress Event Reporting service reports events through the progress of an advanced file transfer route so that reports can be generated.
The following table provides an overview of the AFT Route
Progress Event Reporting service:
System Name | AFT Route Progress Event Reporting Service |
---|---|
Graphical Process Modeler (GPM) categories) | AFT |
Description | Reports an AFT routing progress event |
Business usage | Use this service to add custom reporting events regarding AFT routing progress to a business process to augment the installed capabilities of Sterling B2B Integrator. |
Usage example | When you build a custom AFT routing business process, you can use this service to report AFT routing progress events. |
Preconfigured? | This service is preconfigured as part of the system installation. |
Requires third-party files? | No third-party files are required. |
Platform availability | All supported platforms |
Related services | None |
Application requirements | None |
Initiates business processes? | This service does not initiate business processes. This service cannot be used without a business process. |
Invocation | Used within the business process. |
Business process context considerations | None |
Returned status values | Returned status values:
If the status is ERROR, the status report contains the error details. |
Restrictions | None |
Persistence level | Not applicable |
Testing considerations | Not applicable |
How the AFT Route Progress Event Reporting Service Works
The AFT Route Progress Event Reporting service reports AFT routing progress events when it is called in an AFT routing business process.
Implementing the AFT Route Progress Event Reporting Service
To implement the AFT Route Progress Event Reporting service, use it in a business process.
Configuring the AFT Route Progress Event Reporting Service
There are no configurable parameters for the AFT Route Progress Event Reporting service.
Business Process Example
The following example illustrates how the AFT Route Progress Event Reporting service can be used in a business process:
<process name="AFTRouteReportProgressEvent">
<sequence>
<operation name="GetWorkflowId">
<participant name="This" />
<output message="thisRequest"/>
<input message="thisResponse">
<assign to="AFTRouteWorkflowId"
from="this/node()/text()" />
</input>
</operation>
<operation name="AFT Route Progress Event">
<participant name="AFTRouteProgressEventService"/>
<output message="ProgressBeginRequest">
<assign to="AFTRouteId" from="'2000'" />
<assign to="AFTRouteEventId" from="'AFT_8199'"/>
<assign to="AFTRouteEventMessageParameters"
from="'AFTRouteTest:AFTRouteTestTransportBP'" />
<assign to="." from="*"/>
</output>
<input message="inmsg">
<assign to="." from="*"/>
</input>
</operation>
</sequence>
</process>
Parameters Passed From Service to Business Process
There are no parameters passed from the service to the business process.
Parameters Passed From Business Process to Service
The following table
contains the parameters passed from the business process to the AFT
Route Progress Event Reporting service:
Parameter | Description |
---|---|
AFTRouteId | The data flow ID for this AFT route. Required. |
AFTRouteWorkFlowId | The workflow ID for this AFT route. Required. |
AFTRouteEventID | The ID of the progress event to report. Required. |
AFTRouteEventMessageParameters | A colon-delimited string containing the parameters for the event being reported. Optional. |