The ExecutionHistoryItem represents a job instance. Use AcknowledgeStatus to acknowledge a failure (use 0 for the options parameter).

To retrieve the instance, you can use Job.GetHistory or DataContext.GetJobHistory.

Hi Bill,

I wrote this code. It does not allow me to create an object of ExecutionHistoryItem, as I don't know what arguments the constructor take. Can you help?

public void acknowledge(string jobname)
{
    ExecutionHistoryItem item = new ExecutionHistoryItem(jobname);
    item.AcknowledgeStatus(0);
}

You cannot create an ExecutionHistoryItem--it represents an instance of the job (an entry in the job history). You do not acknowledge a job; you must acknowledge one or more failed instances. You need to use Job.GetHistory or DataContext.GetJobHistory to get the instance(s) that you want to acknowledge.

So if you want to acknowledge all failed instances for a job with a particular name, you need this:

//code to connect to server and get DataContext omitted

//get the job
var job=context.GetJob("Job Name");

//get all failed instances for the job that have not already been acknowledged
var options=new InstanceQueryParameters();
options.StatusAcknowledged= IncludeExcludeType.Exclude;	//only get unacknowledged instances
options.Statuses.AddRange(JobStatusHelpers.FailureStatuses);	//only get instances with an error status
var instances = job.GetExecutionHistory(options);

//acknowledge the instances
foreach (var instance in instances)
{
	instance.AcknowledgeStatus(0);
}

Bill,

Is there a way I can acknowledge only an instance instead of a Job? Probably I Guess I should use chain ID? Can you please let me know more on this ?

As I mentioned above, you never acknowledge a job--always an instance. The code I gave you finds all failed instances for the job and acknowledges them.

A Job object in the API represents a job definition in adTempus. An ExecutionHistoryItem in the API represents an instance of the job (a single execution in the job history).

If you want to acknowledge only a single, specific instance, then you just have to fetch that instance and call Acknowledge (rather than fetching all instances for the job). How you find/fetch that instance depends on what information you have about it. If you are showing a list of instances in your UI and letting the user pick the one to acknowledge, you would use the OID as the key, and fetch it using DataContext.GetObject. The InstanceID is the numeric instance number that is shown to users in the Console. You can find a specific instance number using InstanceQueryParameters.Instances to specify the instance(s) you want when you call GetExecutionHistory.

You'll need to tell me more about what you're trying to do for me to help you more than that.

You would probably not be using the Chain ID to find instances. This is used to link together all related instances when multiple jobs are run in a chain.

Hi Bill,

I wish to do something like this :

Passing the instance id from the UI. (generated the JSON from history.OID.AsString; (from the executionHistory). I just want to acknowledge that instance and not all the instances.

If you have the OID from the instance you want to acknowledge you can just fetch the instance directly:

HI Bill,

I tried this, but its not working. I am not sure if I am generating the correct OID in my JSON data. I am doing the following. I have marked in blue, that is what I am using as the Instance ID. Is that correct? Please let me know.

That should work for getting the OID. What's the string value you end up using for instanceId when you call your method? What line of code is failing? What exception do you get?

I realized there's another method you can use that saves the overhead of fetching the instance first. You can use this single line (note that JobServices is on the Scheduler object, not on the DataContext):

It gives me an "invalid OID" and goes to the catch block after the line :

var oid=new OID(instanceId);

I get String as : B474CCC9-EB0B-4552-8550-C5C951BAB441 ->using this as a string.

Also,

connection.JobServices.AcknowledgeInstanceStatus(new OID[] { instanceId }); gives an error as cannot convert string to OID.

That's not a valid OID representation. AsString() should be returning "18:{B474CCC9-EB0B-4552-8550-C5C951BAB441}". Please check what you're getting back from AsString and make sure it's not getting messed up somewhere along the way.

If that looks correct, show me the code you're using to fetch the instances so I can see what's going on.

Yes, I am getting  "18:{B474CCC9-EB0B-4552-8550-C5C951BAB441}" like this. I render it and send only the OID to the route to get that instance acknowledged, did the same for job id and it was working.

Currently I am not fetching any instance, I am just passing the OID in the route to check if the code is working.

My controller calls the acknowledge function. My route is /api/jobs/acknowledge/B474CCC9-EB0B-4552-8550-C5C951BAB441

The OID is the full value, including the "18:". You cannot pass just the GUID to the OID constructor; it needs the first part (which tells it what kind of object the identifier is for). If you want to pass just the GUID in your route, then you need to use a different constructor for the OID and tell it the class ID. This is what we did in your other example, to convert a job ID to a valid OID for a job. So you need:

var oid=new OID(ClassID.ExecutionHistoryItem, instanceId);

I missed the OID constructor entirely in my alternate example above; the correct version would be:

or