Job Detail Chunking

api_support

I would like to be able to check the delivery status of all the destinations in a Job using JobDetail. I am intending to add 1-n destination lists to each job. Each list could contain 10,000s of records. After the job is submitted, I would like to poll EasyLink at regular intervals to get any new delivery statuses since I called last. To do this I will use the Window fields, i.e. at 9:10 I might ask for all the delivery statuses updates that occurred between 9:00 and 9:10. Then do the same thing at 9:20 and 9:30 and so on. In this way, I will retrieve each delivery status event once and only once. Am I understanding the Window param correctly? Because the result set could contain 1000s of records, I want to be able to retrieve 500 or 1000 records at a time using chunking. So I might retrieve records 1-500, then 501- 1000, 1001-1500, and so on. Is this what the Chunk object is intended to support?

 

The Chunk object defines StartPos as a complex type:

XDN = domain name

MRN = job number

BSJ = Billing Sub Job number

XQN = XQN number of the particular destination from the original job.

I guess I know what XDN and MRN are, although it seems odd to have to specify these when I have already passed these values in the JobId. Is this because you can have parent jobs and child jobs?

 

Can someone please explain what the BSJ is? I can't find any other references to this field.

 

And what is the XQN? Is it just a simple numerical index into the result set?

 

I can get the JobDetail function to return delivery information, but it seems to be ignoring my Chunk object.

 

request.Chunk = new PgiJobDetail.ChunkType();

request.Chunk.StartPos = new PgiJobDetail.PosType();

request.Chunk.StartPos.XDN = textBoxXDN.Text;

request.Chunk.StartPos.MRN = textBoxMRN.Text;

request.Chunk.StartPos.BSJ = 1;

request.Chunk.StartPos.XQN = 1;

request.Chunk.NumRecs = 100;

 

Despite populating this object, I'm always getting all 1000 records back from JobDetail. (NB: I'm not using the Window param at the moment.)

api_support

You are correct on the Window. It will return only those items that had delivery information updates or that had an event occur during that time.

 

For chunking, the easiest way to use it is to only specify the on the first call. The result will contain an EndPos which has the job, bsj and xqn you can use as the StartPos in the next request.

 

The BSJ is the Billing Sub Job number. It is more for our own internal use. That is why you would use the above method.

 

The XQN is indeed the record number returned

 

If you use both the Window and Chunking, you will not miss any records as long as the Window timeframe is the same in the next request.

 

Are you able to provide the XML along with the XDN and MRN for the request?