Pega Warranty APIs
Pega Warranty provides a number of Application Programming Interfaces (APIs) that support external data source integration. The rules in the application reference the data pages to retrieve and update the data. When a rule references a data page, based on the configuration for the data source, the system uses either an existing instance of the data page or creates a new one. The data page defines the freshness of the data.
Sample data is provided in order to view how the interfaces may be used in Pega Warranty. All sample data is maintained in the Pega 7 Platform database tables.
The following tables list the interfaces available in the Pega Warranty application. Interface classes represent Pega data classes that you can redirect to external systems by updating the data pages listed in the data page column.
Each built-on application should override only the necessary interfaces.
| Interface | Data Page | Data Page description | Interface classes | Data base tables involved | Description of tables |
| Product | D_ProductList | Returns the list of products | PegaMfg-Int-Product | mfg_product | Contains transactional data related to a product |
| D_Product | Returns a single product | PegaMfg-Int-ProductMaster | mfg_product_master | Holds master data related to a product | |
| Warranty Information | D_Warranty | Returns a list of warranties for a particular product | PegaMfg-Int-Warranty | mfg_warranty | Holds master data related to a Warranty policy |
| PegaMfg-Int-ProductWarranty | mfg_product_warranty_map | Holds the mapping data between a product and a Warranty policy | |||
| Customer | D_Customer | Returns information for a single customer | PegaApp-Interface-Contact | pa_contact | Holds personal details related to a customer |
| PegaApp-Interface-Address | pa_address | Holds address details of a customer | |||
| Dealer | D_Dealer | Returns data related to a dealer | PegaMfg-Int-Dealer | mfg_dealer | Holds details related to a dealer |
| Supplier | D_Supplier | Returns data related to a supplier | PegaApp-Interface-BusinessUnit | pa_businessunit | Holds details regarding the supplier business unit |
| PegaApp-Interface-Contact-CommunicationOptions | pa_Communication_Options | Holds information related to the communication options | |||
| PegaApp-Interface-Contact | pa_contact | Holds details related to a supplier | |||
| PegaApp-Interface-Address | pa_address | Holds address details of a supplier | |||
| Parts | D_Part | Returns information for a single part | PegaMfg-Int-Parts | mfg_parts | Holds data related to a part cost, markup cost, and so on |
| D_PartList | Returns a list of parts | ||||
| Labor | D_Labor | Returns data related to a single labor code | PegaMfg-Int-LaborCodes | mfg_labor_codes | Holds data related to the labor code, labor description, hourly rate, and so on |
| D_LaborCodeList | Returns a list of labor codes | ||||
| Miscellaneous | D_Misc | Returns data related to a single expense code | PegaMfg-Int-MiscCodes | mfg_misc_codes | Holds data related to the miscellaneous expenses, such as code, description, and so on |
| D_MiscCodeList | Returns a list of expense codes | ||||
| Causal Code | D_CausalCode | Returns data related to a single causal code | PegaMfg-Int-CausalCodes | mfg_causal_codes | Holds master data related to causal codes, such as code and description |
| D_CausalCodeList | Returns a list of causal codes | PegaMfg-Int-RepairDataElementMapping | mfg_repair_elem_map | Holds the mapping between the CausalCode and the other repair
elements, such as Customer ConcernCode, AreaOfFailureCode, and RepairTypeCode | |
| Customer Concern Code | D_CustConcernCode | Returns data related to a single causal code | PegaMfg-Int-CustomerConcernCode | mfg_cust_con_codes | Holds master data related to the customer concern codes, such as code and description |
| D_CustConcernCodeList | Returns a list of a customer concern codes | PegaMfg-Int-RepairDataElementMapping | mfg_repair_elem_map | Holds the mapping between the CustomerConcernCode, and, for example, ProductID | |
| Corrective action | D_CorrectiveAction | Returns data related to a single corrective action code | PegaMfg-Int-CorrectiveAction | mfg_corrective_actions | Holds master data related to the corrective action codes, such as code and description |
| D_CorrectiveActionsList | Returns a list of a corrective actions | ||||
| Pre Defined Repairs | D_PreDefinedRepairList | Returns a list of predefined parts, labor, or miscellaneous expenses for a particular PDRCode | PegaMfg-Int-PreDefinedRepair | mfg_predefined_repairs | Holds mapping data related to a PDR code with the parts, labor, and miscellaneous expense codes |
| Measure units | D_MeasureUnits | Returns a list of measuring units for a particular measure type | PegaMfg-Int-MeasureUnits | mfg_measure_units | Holds measuring units for different measure types |
| Shipping Address | D_Address | Returns data related to a single address code | PegaMfg-Int-Address | mfg_address | Holds data related to the shipping addresses |
| D_Addresses | Returns a list of shipping addresses | ||||
| Countries and AOR mapping | D_AORCountryList | Returns a list of countries in a particular region | PegaMfg-Int-AORCountry | mfg_aor_country_map | Holds data related to the mapping between the countries and the area of responsibility regions |
| Area of failure | D_AreaOfFailure | Returns a list of failure areas based on the product ID and the customer concern code parameters | PegaMfg-Int-AreaOfFailure | mfg_areas_of_failure | Holds master data related to the area of failure, such as code and description |
| PegaMfg-Int-RepairDataElementMapping | mfg_repair_elem_map | Holds the mapping between the CausalCode and the other repair elements, such as CustomerConcernCode or ProductID | |||
| Campaign | D_ProcessedCampaigns | Returns a list of campaigns used for a particular product | PegaMfg-Int-Campaign | mfg_campaign | Holds data related to the campaigns that are used for a particular product |
| Program Criteria Operations | D_CriteriaOperationList | Returns a list with details regarding the type of selections, such as equal to and greater than, which can be used in a common request program | PegaMfg-Int-CriteriaOperation | mfg_program_criteria | Holds details regarding the type of selections, such as equal to and greater than, which can be used in a common request program |
| Document | D_DocumentList | Returns a list of documents | PegaMfg-Int-Document | mfg_document | Holds data related to the documents, such as name, format, location, and so on |
| Instructions | D_Instructions | Returns a list of instructions based on the part/product ID and the type of instructions | PegaMfg-Int-Instructions | mfg_instructions | Holds the data related to the instructions, such as the type of instruction, whether it is a shipping instruction or inspection instruction, and so on |
| PegaMfg-Int-InstructionMapping | mfg_instructions_map | Holds mapping data between the instruction and a part/product ID | |||
| Order | D_RecentOrder | Returns a list of recent orders | PegaMfg-Int-Order | mfg_orders | Holds data related to customer purchase orders |
| OrderItem | D_OrderedItems | Returns a list of order items that are a part of a single order | PegaMfg-Int-OrderItem | mfg_order_items | Holds data related to the order items of different orders |
| Part Serialization | D_PartSerialization | Returns data related to a part serialization | PegaMfg-Int-PartSerialization | mfg_parts_serialization | Holds data related to a part serialization |
| PreDefined Comment | D_PreDefinedComments | Returns a list of predefined comments for a particular BOM category, such as parts, labor, miscellaneous, and so on | PegaMfg-Int-PreDefinedComment | mfg_predefined_comments | Holds predefined comments and the applicable category, such as parts, labor, miscellaneous, and so on |
| CRP Program types | D_ProgramTypesList | Returns a list of the program types to be selected in a common request program | PegaMfg-Int-ProgramTypes | mfg_program_types | Holds data related to the program types that can be selected in a common request program |
| CRP Program and Work type mapping | D_ProgramWorkTypeMappingList | Returns a list of case types for a particular work type | PegaMfg-Int-ProgramWorkTypeMapping | mfg_program_work_map | Holds data related to the mapping between the program type and the case types of a CRP |
| Property Alias | D_PropertyAliasList | Returns a list of property aliases applicable for a particular work type | PegaMfg-Int-PropertyAlias | mfg_property_alias | Holds metadata about the property aliases that are selected in the criteria of the CRP |
| PegaMfg-Int-RepairDataElementMapping | mfg_repair_elem_map | Holds the mapping between the Customer ConcernCode and the other repair elements, such as ProductID | |||
| Repair Type | D_RepairList | Returns a list of repair types based on parameters,
such as ProductID, Areoffailure, and Customer ConcernCode | PegaMfg-Int-RepairType | mfg_repair_types | Holds master data related to the repair types |
| PegaMfg-Int-RepairDataElementMapping | mfg_repair_elem_map | Holds the mapping between the repair type and the other repair elements, such as ProductID, AreaOfFailure, and CustomerConcernCode | |||
| Repair Vendor | D_RepairVendorList | Returns all data related to the repair technicians | PegaMfg-Int-RepairVendor | mfg_repair_vendor | Holds data related to the repair technicians, such as name, address, and so on |
| PegaMfg-Int-VendorAvailability | mfg_vendor_availability | Holds data related to the availability of the repair technicians | |||
| CRP Response Mapping | D_ResponseMappingList | Returns details related to the response types that are available for a particular program and case type | PegaMfg-Int-ResponseMapping | mfg_response_mapping | Holds details related to the response types available for a particular program and case type |
| Supplier contract details | PegaMfg-Int-Supplier | mfg_supplier | Holds data related to the supplier contract with the manufacturer | ||
| Part Disposition | D_Dispositions | Returns a list of dispositions applicable for a part | PegaMfg-Int-Dispositions | mfg_dispositions | Holds the dispositions applicable for a part |
In the auto specialization some of the above interfaces have been modified to point to a different database tables:
| Interface | Data Page | Data page description | Interface classes | Data base tables involved | Description of tables |
| Vehicle | D_ProductsList | Returns a list of products | PegaMfg-Int-Product_Auto | mfg_product_auto | Holds transactional data related to a vehicle |
| D_Product | Returns a single product | PegaMfg-Int-ProductMaster | mfg_product_master | Holds the generic master data related to a vehicle | |
| PegaMfg-Int-ProductMaster_Auto | mfg_product_master_auto | Holds the auto-specific master data related to a vehicle | |||
| Parts | D_Part | Returns information about a single part | PegaMfg-Int-Parts_Auto | mfg_parts_auto | Holds data related a part, such as the part cost, markup cost, and so on |
| D_PartList | Returns a list of parts | ||||
| Causal Code | D_CausalCode | Returns data related to a single causal code | PegaMfg-Int-CausalCode_Auto | mfg_causal_codes_auto | Holds master data related to causal codes, such as code and description |
| D_CausalCodeList | Returns a list of causal codes | PegaMfg-Int-RepairDataElementMapping_Auto | mfg_repair_elem_map_auto | Holds the mapping between the CausalCode and the other repair
elements, such as the Customer ConcernCode, AreaOfFailureCode, RepairTypeCode, and so on | |
| Customer Concern Code | D_CustConcernCode | Returns data related to a single causal code | PegaMfg-Int-CustomerConcernCode_Auto | mfg_cust_con_codes_auto | Holds master data related to customer concern codes, such as code and description |
| D_CustConcernCodeList | Returns a list of a customer concern codes | PegaMfg-Int-RepairDataElementMapping_Auto | mfg_repair_elem_map_auto | Holds the mapping between the Customer ConcernCode and the other repair elements, such as ProductID | |
| Repair Type | D_RepairList | Returns a list of repair types based on the parameters,
such as ProductID, AreaOfFailure, Customer ConcernCode, and so on | PegaMfg-Int-RepairType_Auto | mfg_repair_types_auto | Holds master data related to repair types |
| PegaMfg-Int-RepairDataElementMapping_Auto | mfg_repair_elem_map_auto | Holds the mapping between the repair type and the other repair
elements, such as ProductID, AreaOfFailure, Customer ConcernCode, and so on |
Previous topic Pega Warranty ruleset list