EasyLink connectors > EasyLink job status reporting

EasyLink job status reporting
The EasyLink reporting service generates reports with status information for jobs sent via EasyLink. The StreamServe Task Scheduler application can retrieve status information from EasyLink, and StreamServer applications can use the status information for the following purposes:
EasyLink account requirements
To use the EasyLink reporting service, you need to contact EasyLink Customer service and request that the scheduled reporting functionality be added to your account.
Steps overview
Follow these steps to set up status reports for EasyLink jobs or update the top job status with the EasyLink job status:
(Optional) If you want to update the StreamServe top job status with the EasyLink job status, enable External Job Completion for the EasyLink output connector. See Enabling EasyLink to update the top job status.
(Optional) If you want to generate custom actions or format the reports, set up a StreamServer application with a Service Request input connector, MessageIN Event, and an appropriate Process. See Setting up a Project to the format the reports or generate custom actions.
Setting up a connection to the EasyLink reporting service
You must create a new web service profile in Control Center for the EasyLink reporting service with a new Authentication profile and a new Secure Channel profile. You must also import the Certificate file to the new profile.
To set up a web service profile for the EasyLink reporting service
1
In Control Center, from the Repositories node, create a new repository with the type EasyLink Reports.
2
The URL for the EasyLink reporting service is the same as the URL for the web service profile used by the connectors. For descriptions of the parameters, see Setting up a web service connection profile for EasyLink.
3
Create a new Authentication profile for your EasyLink user name and password.
4
Create a new Secure channel profile.
5
In the Secure Channel profile, create a new Certificate store profile, add a new trusted authorities certificate and import the certificate file.
6
Creating a Task Scheduler to retrieve the EasyLink reports
Because EasyLink generates reports with the status information every 15 minutes, we recommend that you use intervals longer than 15 minutes for the Task Scheduler application.
1
In Control Center, create a new Task Scheduler application.
2
In the Configuration dialog box, in the Tasks box click..., and then add an EasyLink Reports tasks.
3
4
Set up the schedule for retrieving the status information. See Scheduler Configuration dialog box in Control Center documentation for more information about setting up schedules.
5
If you want to use a StreamServer application to format the status reports or generate custom actions based on the reports, in the Service name box, enter the name of the service that will receive the reports. This must match the Service name in the Service Request input connector.
6
Enabling EasyLink to update the top job status
You must enable External Job Completion in the output connector if you want to update the StreamServe top job status with the EasyLink job status.
Considerations for using external job completion
When you use the External Job Completion option for an EasyLink output connector, the Customer Reference is replaced with the GUID for the job ID.
External job completion cannot be used if batches of message are sent to EasyLink. When these settings are used together, unexpected results are returned.
If a top job is never marked as completed by EasyLink, you must use Database Administration Tool to cancel the top job.
To enable External job Completion
In the EasyLink connector, click True for External Job Completion.
Setting up a Project to the format the reports or generate custom actions
To set up a StreamServer application to format the status information from EasyLink or generate custom actions based on the status information, you add a Service Request input connector, MessageIN Event, and an appropriate Process to your Project.
To set up a Project to format the status reports or generate custom actions
1
Add a Service Request input connector to your Project.
a
In the Request type list, click Notification.
b
In the Service name box, enter the Service name you entered in the Task Scheduler.
2
Add the EasyLinkNotification SXD file to the resource set. This file is found in the OpenText StreamServe installation directory.
3
4
5
Set up an appropriate Process and output connector to format and deliver the reports or generate custom actions based on the reports.
OpenText StreamServe 5.6.2 Updated: 2018-01-26