Insurance Product General Operations
The Insurance Product Factory solution enables you to create, adjust and maintain Insurance Products. Read below about the endpoints, scripts and libraries used for implementing this functionality.
Server Side Library
FTOS_IP_InsuranceProduct_Operations
This server side script library stores methods for various actions that a user can perform on an insurance product, or coverage. These methods were divided in two main classes, in order to keep the functionalities on the product separate from the ones on the product items (coverages).
This class holds methods only used for operations performed at the product level.
This function returns a list with only one product Id that was found based on the existing lookup on a specific insurance product item (coverage) Id.
Input parameters: productItemId - The Id of the insurance product item (coverage).
Output parameters: List with the product Id.
This function returns a list with only one underwriting type that was found for a product with a specific Id.
Input parameters: productId - The Id of the insurance product.
Output parameters: List with the product underwriting type.
This function returns an object that will contain the underwriting type set on a specific insurance product
Input parameters: productId - The Id of the insurance product for which the underwriting type will be returned.
Output parameters: validationObj - The object containing the underwriting type.
This function returns a list with only one tariff type that was found for a product with a specific Id.
Input parameters: productId - The Id of the insurance product.
Output parameters: List with the product tariff type.
This function returns an object that contains the tariff type set on a specific insurance product.
Input parameters: productId - The Id of the insurance product for which the tariff type is returned.
Output parameters: validationObj - The object containing the tariff type.
This function deletes the formulas attached on a specific insurance product.
Input parameters:
-
entityNamesList- The list of entities. -
insuranceProductId- The Id of the insurance product.
Output parameters: N/A.
This class holds methods only used for operations performed at the coverage level.
This function returns a list with underwriting formulas attached on coverage level - for a specific product Id, insurance item Id and context type Id.
Input parameters:
-
insuranceProductId- The Id of the specific insurance product item (coverage). -
insuranceProductItemId- The Id of the specific insurance product. -
contextTypeId- The Id of the specific context type.
Output parameters: List with underwriting formulas.
This function validates if the newly added formula contains a unique combination of insurance product, insurance product item (coverage) and context type. If the data is duplicated or the formula name already exists, this function throws an error.
Input parameters:
-
coverageFormulaName- The name of the formula which is about to be inserted or updated. -
insuranceProductId- The Id of the selected insurance product. -
insuranceProductItemId- The Id of the selected insurance product item (coverage). -
contextTypeId- The Id of the selected context type. -
maxNumber- The maximum number of records necessary for validation.
Output parameters: N/A.
This function checks the attached underwriting formula for updates. Next, if it finds any change, the function updates the specific record from the FTOS_CALC_DataMapping entity.
Input parameters:
-
formulaId- The Id of the selected formula. -
insuranceProductItemId- The Id of the selected insurance product item (coverage). -
contextTypeId- The Id of the selected context type. -
dataMappingId- The Id of the related data mapping record.
Output parameters: N/A.
This function is called when the user clicks the Map Data button for inserting a new record in the FTOS_CALC_DataMapping entity, with some data from the underwriting formula. It also updates the related formula with the new data mapping Id.
Input parameters:
-
formulaId- The Id of the selected formula. -
contextTypeId- The Id of the selected context type.
Output parameters: N/A.
This function inserts a new record in the FTOS_CALC_DataMapping entity, with some data from the underwriting formula.
Input parameters:
-
ipFormulaData- The data object for the selected formula. -
formulaId- The Id of the selected formula.
Output parameters: N/A.
This function runs some validations before calling the insertNewDataMapping() function.
Input parameters:
-
insuranceProductData(ipFormulaData) - The data object (containing details of the insurance product) for the selected formula. -
insuranceProductItemId- The Id of the selected insurance product item (coverage). -
contextTypeId- The Id of the selected context type. -
formulaId- The Id of the selected formula.
Output parameters: N/A.
This function returns a list with some data objects for the insurance coverages found.
Input parameters: productId - The Id of the selected insurance product.
Output parameters: List with insurance coverages.
This function returns different attributes from the FTOS_IP_InsuranceProductItem entity, based on the product id.
Input parameters: productId - The Id of the selected insurance product.
Output parameters: query - An array that contains an object with the following results: FTOSIPInsuranceProductItemId, and Name.
This function returns different attributes from a versioned record of the FTOS_IP_InsuranceProductItem entity, based on the versioned product id;
Input parameters: productId - The Id of the selected insurance product.
Output parameters: query - An array that contains an object with the following results: Percentage.
This function returns different attributes from a record of the FTOS_IP_InsuranceProduct entity, based on the product id.
Input parameters: productId - The Id of the selected insurance product.
Output parameters: query - An array that contains an object with the following results: attributeVersion, Name, TariffType, ReferencedAttributeId, and ClonedProductId.
This function returns different attributes from a record of the FTOS_IP_PremiumCoverageSplit entity, based on the product coverage id and product formula id.
Input parameters:
-
productItemId- The Id of the product coverage. -
productFormulaId- The Id of the product formula.
Output parameters: query - An array that contains an object with the following results: Name.
This function returns different attributes from a record of the FTOS_IP_PremiumCoverageSplit entity, based on the product coverage id.
Input parameters: coverageId - The Id of the product coverage.
Output parameters: query - An array that contains an object with the following results: Name, and Percentage.
This function returns different attributes from a record of the FTOS_IP_InsuranceProductFormula entity, based on the product id.
Input parameters: productId - The Id of the insurance product.
Output parameters:
query - An array that contains an object with the following results: Name.
This function returns information about a product, based on the coverage Id.
Input parameters: parentId - The Id of the coverage.
Output parameters: The query object.
This function returns information about a product, based on the module Id.
Input parameters: moduleId - The Id of the module.
Output parameters: The query object.
This function returns information about a product, based on the product formula Id.
Input parameters: formulaId - The Id of the product formula.
Output parameters: The query object.
This function returns information about a product, based on the coverage formula Id.
Input parameters: formulaId - The Id of the coverage formula.
Output parameters: The query object.
This function returns information about a product, based on the product underwriting formula Id.
Input parameters: formulaId - The Id of the product underwriting formula.
Output parameters: The query object.
This function returns information about a product, based on the coverage underwriting formula Id.
Input parameters:formulaId - The Id of the coverage underwriting formula.
Output parameters: The query object.
This function returns information about a formula data mapping, based on the data mapping Id.
Input parameters: mappingId - The Id of the data mapping.
Output parameters: The query object.
This function checks if the status of a product is in Draft or Version draft status and throws an error.
Input parameters:
-
id- The Id used to retrieve the product’s information. -
functionName- The name of the function used to retrieve the product’s information. -
resource- The message the error throws when the product is not in Draft or Version Draft status.
Output parameters: N/A.
Endpoints
Endpoint used to run the FTOS_IP_CheckBusinessStatus server automation script.
Endpoint used to run the FTOS_IP_CheckBusinessStatusItem server automation script.
Endpoint used to run the FTOS_IP_CheckBusinessStatusModule server automation script.
Endpoint used to run the FTOS_IP_CheckBusinessStatusByFormula server automation script.
Server Side On-demand Scripts
Based on the provided insurance product ID, this script checks if the product is in draft or version draft status and returns a boolean.
Input parameters: productId - The insurance product Id.
Output parameters: check - The boolean that determines if the product is in the correct status.
Based on the provided insurance product item ID, this script checks if the product is in draft or version draft status and returns a boolean.
Input parameters: itemId - The insurance product item Id.
Output parameters: check - The boolean that determines if the product is in the correct status.
Based on the provided insurance product module ID, this script checks if the product is in draft or version draft status and returns a boolean.
Input Parameters: moduleId - The insurance product module Id.
Output parameters: check - The boolean that determines if the product is in the correct status.
Based on the provided insurance product formula ID, this script checks if the product is in Draft or Version Draft status and returns a boolean.
Input parameters: formulaId - The insurance product formula Id.
Output parameters: check - The boolean that determines if the product is in the correct status.