Input Tool

The input tool interface allows the calling application to request user interface information for a given account and loan type. The SCE then reads the setup files for the specified account, and returns information useful for determining what prompts and/or options should be displayed to the user.

What type of user interface information is returned? Whether or not insurance is allowed on a given loan type, the number of payments per year allowed, etc. For a complete description, see the output definition in the last half of the chapter.

Sample Request

The following is a sample request for the Input Tool module:

<inINPUT_TOOL
   Account="1"
   DataDirPath="C:\SCEX\"
   ForceReload="false"
   LoanType="Equal"
/>

Note that like the Version module, the Input Tool request consists solely of one empty root element. All data sent as part of the request is in the form of attributes of the root element.

Sample Response

The following is a sample response returned by the previous sample request:

<?xml version="1.0" standalone="no" ?>
<!DOCTYPE outINPUT_TOOL SYSTEM "outINPUT_TOOL.dtd">
<outINPUT_TOOL>
 <CalcResult>Valid Calculation</CalcResult>
 <LoanSetup>
  <DefaultDays>30</DefaultDays>
  <MinDays>1</MinDays>
  <MaxDays>90</MaxDays>
  <MaxDaysSinglePay>365</MaxDaysSinglePay>
  <DefAmount>20000.00</DefAmount>
  <MinAmount>0.00</MinAmount>
  <MaxAmount>10000000.00</MaxAmount>
  <ShowRate>1</ShowRate>
  <DefRate>10.000</DefRate>
  <MinRate>0.002</MinRate>
  <MaxRate>21.00</MaxRate>
  <ShowPPY>1</ShowPPY>
  <PPY>11111111</PPY>
  <DefTerm>36</DefTerm>
  <MinTerm>2</MinTerm>
  <MaxTerm>360</MaxTerm>
  <PromptFinIns>0</PromptFinIns>
  <AllowPast28>1</AllowPast28>
  <AllowAutoLoans>0</AllowAutoLoans>
  <True360>0</True360>
  <DebtProtection>0</DebtProtection>
  <DebtTitle>Debt Protection</DebtTitle>
  <ShowHOEPALoanType>0</ShowHOEPALoanType>
  <PremiumType>0</PremiumType>
  <PromptOpenEnd>0</PromptOpenEnd>
  <DiscloseHOEPA>2</DiscloseHOEPA>
  <AcceleratedBiWeekly>0</AcceleratedBiWeekly>
  <DefaultBirthday>19660416</DefaultBirthday>
 </LoanSetup>
 <ARM>
  <FirstRateIncrease>2.000</FirstRateIncrease>
  <RoundRate>0.000</RoundRate>
  <TeaserTermDef>24</TeaserTermDef>
  <TermInc>12</TermInc>
  <TeaserRateDef>6.000</TeaserRateDef>
  <MaxAnnualInc>2.000</MaxAnnualInc>
  <MaxLoanInc>6.000</MaxLoanInc>
  <MinLifeRate>0.000</MinLifeRate>
  <MaxLifeRate>0.000</MaxLifeRate>
 </ARM>
 <PMI>
  <AllowPMI>0</AllowPMI>
  <AssumePMI>0</AssumePMI>
  <UpFront>2</UpFront>
  <PercentToWarn>0</PercentToWarn>
  <PercentToRemove>80</PercentToRemove>
  <AddToPrin>0</AddToPrin>
  <AddToFinChg>0</AddToFinChg>
  <PutPMIinAmort>0</PutInAmort>
  <PromptFrequency>1</PromptFrequency>
  <PromptUpFront>0</PromptUpFront>
  <PromptAddToPrin>0</PromptAddToPrin>
  <PromptAddToFinChg>0</PromptAddToFinChg>
 </PMI>
 <CreditLife>
  <CLTitle>Credit Life</CLTitle>
  <CLAbbrev>CL</CLAbbrev>
  <CLAllow>1</CLAllow>
  <CLSingleOnCoBorrower>0</CLSingleOnCoBorrower>
  <CLDefault>1</CLDefault>
  <CLDefaultMethod>1</CLDefaultMethod>
  <CLPromptMethod>0</CLPromptMethod>
  <CLPromptTermGross>0</CLPromptTermGross>
  <CLPromptTermNet>1</CLPromptTermNet>
  <CLPromptTermMOB>0</CLPromptTermMOB>
  <CLPromptDismemberment>1</CLPromptDismemberment>
  <CLPromptUseLevelRates>1</CLPromptUseLevelRates>
  <CLPromptBirthdaysGross>0</CLPromptBirthdaysGross>
  <CLPromptBirthdaysNet>1</CLPromptBirthdaysNet>
  <CLPromptBirthdaysMOB>0</CLPromptBirthdaysMOB>
  <CLPromptCov>0</CLPromptCov>
  <CLMinLoanTerm>0</CLMinLoanTerm>
  <CLMinTruncTerm>0</CLMinTruncTerm>
  <CLAllowNonMonthlyGross>1</CLAllowNonMonthlyGross>
  <CLAllowWeeklyGross>1</CLAllowWeeklyGross>
  <CLAllowNonMonthlyNet>1</CLAllowNonMonthlyNet>
  <CLAllowWeeklyNet>1</CLAllowWeeklyNet>
  <CLAllowNonMonthlyMOB>0</CLAllowNonMonthlyMOB>
  <CLAllowWeeklyMOB>0</CLAllowWeeklyMOB>
  <CLMult>6</CLMult>
  <CLNBCManditory>0</CLNBCManditory>
  <LLTitle>Level Life</LLTitle>
  <LLAbbrev>LL</LLAbbrev>
 </CreditLife>
 <AccidentHealth>
  <AHTitle>Accident &amp; Health</AHTitle>
  <AHAbbrev>AH</AHAbbrev>
  <AHAllow>1</AHAllow>
  <AHSingleOnCoBorrower>0</AHSingleOnCoBorrower>
  <AHMethod>0</AHMethod>
  <AHAllowBalloonGross>1</AHAllowBalloonGross>
  <AHAllowBalloonNet>1</AHAllowBalloonNet>
  <AHDefault>1</AHDefault>
  <AHPromptBenefit>0</AHPromptBenefit>
  <AHPromptTermGross>0</AHPromptTermGross>
  <AHPromptTermNet>0</AHPromptTermNet>
  <AHMinTruncTerm>0</AHMinTruncTerm>
  <AHPromptBirthdays>1</AHPromptBirthdays>
  <AHMult>1</AHMult>
  <AHOnly>1</AHOnly>
  <AHJointWOJointCL>1</AHJointWOJointCL>
  <AHNonMonthly>1</AHNonMonthly>
  <AHSetCount>1</AHSetCount>
  <AHSetTitle>14 Retro</AHSetTitle>
  <AHCoverBalloon>0</AHCoverBalloon>
  <AHTermEqualsCL>0</AHTermEqualsCL>
 </AccidentHealth>
 <InvoluntaryUnemployment>
  <IUTitle>Involuntary Unemployment</IUTitle>
  <IUAbbrev>IU</IUAbbrev>
  <IUAllow>1</IUAllow>
  <IUDefault>1</IUDefault>
  <IUSingleOnCoBorrower>0</IUSingleOnCoBorrower>
  <IUOnly>1</IUOnly>
  <IUJointWOJointCL>1</IUJointWOJointCL>
  <IUwoAH>1</IUwoAH>
  <IUJointWOJointAH>1</IUJointWOJointAH>
  <IUPromptBenefit>0</IUPromptBenefit>
  <IUPromptTerm>0</IUPromptTerm>
  <IUMult>1</IUMult>
  <IUPromptBirthdays>0</IUPromptBirthdays>
  <IUTermEqualsCLTerm>0</IUTermEqualsCLTerm>
  <IUNonMonthly>0</IUNonMonthly>
 </InvoluntaryUnemployment>
 <PersonalProperty>
  <PPTitle>Personal Property</PPTitle>
  <PPAbbrev>PP</PPAbbrev>
  <PPAllow>1</PPAllow>
  <PPDefault>1</PPDefault>
  <PPPromptCoverage>0</PPPromptCoverage>
 </PersonalProperty>
</outINPUT_TOOL>