I wanted to put together a brief article around integrating ServiceNow with Dell's TechDirect warranty API to collect an asset's Warranty Expiration date. In this article, I will detail the Outbound REST message setup, scripting the business rules and UI action I used. This will be some basic REST work, but I thought I would share. Please feel free to comment if you see errors or improvements I can make.
Obtain your Dell API key from Dell TechDirect. Once you are approved for a key, Dell will provide the key along with some code samples (see the attached PDF). Currently I have a key only for their Warranty API.
Setting up the Outbound REST message and GET method:
- Create a new Outbound REST message with endpoint https://sandbox.api.dell.com/support/assetinfo/v4 (Dell will initially setup you up within their sandbox environment and then migrate your work to their prod endpoint)
- Add HTTP headers for Accept and Content-Type, both with a value of application/json
- Save the new record, which will create your default GET method.
- Obtaining the warranty end date requires endpoint: https://sandbox.api.dell.com/support/assetinfo/v4/getassetwarranty/{id}?apikey={apikey}
- Setup your GET method for some test runs with the following attributes:
- Endpoint: https://sandbox.api.dell.com/support/assetinfo/v4/geassetwarranty/${id}
- HTTP headers for Accept and Content-Type, both with a value of application/json
- HTTP Query Parameter for apikey where the value is your key (We'll remove this parameter later and store the key as a property).
- Variable substitutions for id with a value of a valid service tag
You want to grab the EndDate value from AssetEntitlementData[0] array.
Setting up a Business Rule to update Warranty Expiration
I decided to setup an On Before Insert and Update business rule to run when the Warranty Expiration field is empty and the Serial Number is not empty and the workstation is not a Mac.
(function executeRule(current, previous /*null when async*/) {
var st = current.serial_number;
try {
var r = new sn_ws.RESTMessageV2('DellTechDirect', 'GET');
r.setStringParameterNoEscape('id', st);
r.setQueryParameter('apikey', gs.getProperty('DellTechDirectKey'));
r.setHttpTimeout(10000);
r.setEccParameter('skip_sensor', true);
var response = r.execute();
var responseBody = response.getBody();
var httpStatus = response.getStatusCode();
gs.info("Status = " + httpStatus);
gs.info("Response Body = " + responseBody);
if (httpStatus == '200'){
var responseObj = JSON.parse(responseBody);
var edate = responseObj.AssetWarrantyResponse[0].AssetEntitlementData[0].EndDate.substring(0, 10);
current.warranty_expiration = edate;
}else{
gs.addErrorMessage('Looks like we ran into a problem. HTTP status: ' + httpStatus);
}
}
catch(ex) {
var message = ex.getMessage();
}
})(current, previous);Setting up the UI Action to check warranty expiration:
I setup a Form Button UI action to only display if the Serial Number is not empty and the workstation is not a Mac. This gives our Service Desk a method to validate the Warranty Expiration.
var st = current.serial_number;
var curdate = current.warranty_expiration;
try {
var r = new sn_ws.RESTMessageV2('DellTechDirect', 'GET');
r.setStringParameterNoEscape('service_tag', st);
//r.setQueryParameter(gs.getProperty('DellTechDirectKey'));
r.setQueryParameter('apikey', gs.getProperty('DellTechDirectKey'));
r.setHttpTimeout(10000);
r.setEccParameter('skip_sensor', true);
var response = r.execute();
var responseBody = response.getBody();
var httpStatus = response.getStatusCode();
gs.info("Status = " + httpStatus);
gs.info("Response Body = " + responseBody);
if(httpStatus == '200'){
var responseObj = JSON.parse(responseBody);
var edate = responseObj.AssetWarrantyResponse[0].AssetEntitlementData[0].EndDate.substring(0, 10);
if(curdate == edate){
gs.addInfoMessage('The Warranty Expiration date is correct');
action.setRedirectURL(current);
current.update();
}
if(curdate != edate){
gs.addInfoMessage('The Warranty Expiration date changed from ' + curdate + ' to ' + edate);
current.warranty_expiration = edate;
action.setRedirectURL(current);
current.update();
}
}
else{
gs.addErrorMessage('Could not retrieve Warranty Expiration information: ' + httpStatus);
action.setRedirectURL(current);
current.update();
}
}
catch(ex) {
var message = ex.getMessage();
}I hope this is helpful and please let me know if you have any feedback.
Hey Robert
You will need to add a "setQueryParameter" value when you call your REST method. I used the line "r.setQueryParameter('apikey', gs.getProperty('DellTechDirectKey'));" This will generate the URL in the format: https://api.dell.com/support/assetinfo/v4/getassetwarranty/?apikey= <valid API key>
More info on the setQueryParameter.
Are you able to see End Date under the AssetEntitlementData response? I had to parse the response arrays to get the end date I wanted.
Let me know if this helps. Thanks for checking out the post.
Rick
I'm glad the article is helpful. The apikey property is called in this line:
r.setQueryParameter('apikey', gs.getProperty('DellTechDirectKey'));
You'll need to setup a new system property to store your key value.
Let me know if you have any questions.
I think I see what you are referring to. I have a JSON element for "Dell Digital Delivery". I'm probably working on the assumption that my standard warranty end date is the first value in the AssetEntitementData array (responseObj.AssetWarrantyResponse[0].AssetEntitlementData[0].EndDate.substring(0, 10);)
1. You'll need to create an OAuth Profile with the application registries.
note: the "Client Secret" is at the end of the API Key ********* (1234567) and the "Client ID" is the API Key.
2. Endpoint changes:
3. Now for the GET Authentication settings:
4. Lastly, the HTTP Request no longer needs the API key since we placed it in the Token Profile:
Let me know if you need any more instructions.
When using the Authentication type inherited from parent and is not a MID Server, the property below should be checked.
At least here it worked.
Hello All,
I am currently working on integrating Tech Direct with ServiceNow and this post has helped me a lot. I got the required details from the TechDirect(API key, client ID, secret value), I have created a rest message with required details and endpoints, also created oAUTH profile, for authentication with client ID and secret value,
After the configuration when i have tested, I am getting the below error, Can anyone guide me through this.
Hey @Steven Parker
The OAuth token should renew automatically every time the scheduled job runs,
If you're talking about the message in the yellow box below, that is normal, the token is valid for one hour only. But every time the job runs, it renew it for that hour.
You can also retrieve the token by clicking the link in the related links:
If clicking the link returns an error, then you should check with your Dell rep.
