JD Warranty Interface
The JD Warranty Interface allows dealers to submit warranty claims out of John Deere DBS 365 to the John Deere Warranty System (JDWS) and receive information about their current status. This integration is needed to create warranty claims in case of a machine failure or a PIP (Product Improvement Program) / PEP (Product Enhancement Program) case launched by John Deere. After processing the warranty claim, the vendor will send a credit memo which will then be posted in John Deere DBS 365.
For this process, XML files are used to submit the corresponding warranty claim data to and from John Deere. These files are created, transferred and received via John Deere DBS 365.
In this chapter, you can find the following sections:
Setup
Please perform the setup in the following order:
- JD Warranty Interface setup
- Warranty mapping setup
- Warranty claim update job queue setup
- Warranty info retrieval job queue setup
JD Warranty Interface setup
First, the basic interface setup must be performed. Please proceed as follows:
- Open the Interface List table in John Deere DBS 365 and select the JDWARRANTY entry.
- In the General FastTab:
- Activate the Interface Log toggle switch to keep a record of all JD Warranty Interface activities via the Log button in the menu bar.
Tip
If needed, enable automatic clearing of lines on the Interface Log page after a specific time by entering a value in the Delete Log Entries After field.
Example: 90D = all log entries older than 90 days are automatically deleted. Information about entering a time frame can be found here.
- In the Authorization FastTab:
- In the Authorization Type field, select the OAuth2 value.
- In the Authorization Code field, select the WARR PROD value.
- In the Scope field, select the JDWARRANTY value.
- In the Parameters FastTab, enter the following information in the Value field to prepare the interface:
- BatchStartDateFormula: Defines the date range from which on the warranty information is updated, e.g.,
-3Yequals three years back from current work date, i.e., all service items which have warranty information available from three years ago up to today are updated (no matter whether or not the warranty is already expired).
The parameter value must always be a negative value, i.e., it must be preceded by a dash (-). - CustomerNoSelfBilling: Optional Select the John Deere customer that should be used for the self-billing process.
- DbsId: Optional Select the user which should be used for the Warranty Interface.
- LaborResourceNo: Select the resource number that will allow using labor times coming with PIPs.
- LanguageCode: manually add the language code to be used by JD WAPS return messages. The following language codes are available:
DE,EN,ES,FR,IT,PT.
Default value:EN - LughtUseIndicator: Select the unit of measure which is used for the lug height. The following values are available: MM (millimeters) and IN (inches).
Default value:MM - MsgVersion: This value is required in the input of all messages to and from JD WAPS.
Default value:1.0 - PortalUrl: Defines the Warranty Portal URL as defined in the official interface description by John Deere.
Default value:http://jdwarrantysystem.deere.com/index.html - VendorNo: Select the vendor number that will allow using the Warranty web service interface in warranty claims.
- WarrantyTypeBasic: Select the warranty type which should be used for basic warranty cases of a service item.
- WarrantyTypeComprehensive: Select the warranty type which should be used for PowerGard Protection Plus warranty cases of a service item.
- WarrantyTypePowertrain: Select the warranty type which should be used for PowerGard Protection warranty cases of a service item.
- WebserviceUrl: Defines the URL for the Warranty web service as defined in the official interface description by John Deere.
Default value:https://warrantyext-api-prod.deere.com/digcust/wy/
- BatchStartDateFormula: Defines the date range from which on the warranty information is updated, e.g.,
When all requirements are met (green or grey values in the Parameters FastTab), users can enable the interface via the Activate Interface button of the JD Warranty Interface Card.
Important
Please be aware that the warranty note setup used to import and process warranty notes from John Deere is part of the JD Document setup. Please make sure to adjust the parameters mentioned under Warranty notes as well.
Please proceed with the Warranty mapping setup section.
Warranty mapping setup
The warranty mapping is needed to map the John Deere warranty codes with the dealer's warranty codes. Most of the values are automatically set up during initialization, but there are still some dealer-specific values which must be defined manually.
To set up the warranty mapping, please proceed as follows:
- Open the JDWARRANTY entry in the Interface List table, and click on the Warranty > Warranty Mapping button in the menu bar.
- In the John Deere Warranty Mapping List table, filter for empty values in the Reference column, and enter the corresponding value.
Tip
The Code value is submitted to John Deere, the Reference value is used in internal documents.
Please proceed with the Warranty claim update job queue setup section.
Warranty claim update job queue setup
This job queue is used for the automatic update of warranty information of John Deere service items within a specific date range and for all John Deere dealer number / X ID combinations which have the Warranty checkbox selected on the John Deere User Mappings page. When activating the JD Warranty Interface, a smart notification is displayed from where the job queue could be opened directly, if necessary.
It is automatically created during the JD Warranty Interface setup, so it is not necessary to create it manually. In case the job queue was changed or reset, please follow below instructions to recreate the recommended settings:
- Open the Job Queue Entries table in John Deere DBS 365 using the quick search (ALT+Q).
- Click on the New button to create a new job queue entry.
- In the General FastTab of the Job Queue Entry Card page, do the following:
- In the Object Type to Run field, select the
Codeunitvalue. - In the Object ID to Run field, select the
5575074value. - Optional In the Description field, enter a unique job queue description, if needed, e.g.,
Warranty Claim Status Update. - Optional In the Earliest Start Date/Time field, enter the date and time the job queue should run the next time. If no value is selected, the job queue will run as soon as Status = Ready.
- In the Object Type to Run field, select the
- In the Recurrence FastTab of the Job Queue Entry Card page, do the following:
- Activate the toggle switches for all weekdays.
- In the Starting Time field, select a time shortly before the usual business hours, so that the JD Warranty Interface data is already up to date when starting.
Recommended value:05:00:00(05:00:00 AM). - In the Ending Time field, select a time after the usual business hours, so that no traffic is generated if it is not needed.
Recommended value:23:00:00(11:00:00 PM) - In the No. of Minutes between Runs field, enter a value which suits your processes best. We recommend a value of
5.
The job queue entry is finished and has Status = On Hold.
Note
All information downloaded via this job queue is buffered in a temporary table and then copied to the Warranty > Service Item Warranty > Service Item Warranties table of the individual service items.
Warranty info retrieval job queue setup
This job queue is used for the automatic update of the warranty status. When activating the JD Warranty Interface, a smart notification is displayed from where the job queue could be opened directly, if necessary.
It is automatically created during the JD Warranty Interface setup, so it is not necessary to create it manually. In case the job queue was changed or reset, please follow below instructions to recreate the recommended settings:
- Open the Job Queue Entries table in John Deere DBS 365 using the quick search (ALT+Q).
- Click on the New button to create a new job queue entry.
- In the General FastTab of the Job Queue Entry Card page, do the following:
- In the Object Type to Run field, select the
Codeunitvalue. - In the Object ID to Run field, select the
5575239value. - Optional In the Description field, enter a unique job queue description, if needed, e.g.,
Warranty Claim Update. - Optional In the Earliest Start Date/Time field, enter the date and time the job queue should run the next time. If no value is selected, the job queue will run as soon as Status = Ready.
- In the Object Type to Run field, select the
- In the Recurrence FastTab of the Job Queue Entry Card page, do the following:
- Activate the toggle switches for all weekdays.
- In the Starting Time field, select a time shortly before the usual business hours, so that the JD Warranty Interface data is already up to date when starting.
Recommended value:05:00:00(05:00:00 AM). - In the Ending Time field, select a time after the usual business hours, so that no traffic is generated if it is not needed.
Recommended value:23:00:00(11:00:00 PM) - In the No. of Minutes between Runs field, enter a value which suits your processes best. We recommend a value of
5.
The job queue entry is finished and has Status = On Hold.
User Guide
For warranty processes, please check the following links: