Input Tool - Request
Please see the Legend to understand the conventions used to document each element and attribute. Note that for requests, the XML elements are documented in alphabetical order by parent element.
| Element | Attributes |
|---|---|
<inINPUT_TOOL> | 🔹Account, 🔹DataDirPath, 🔹ForceReload, 🔹LoanType |
🟥 <inINPUT_TOOL>
| Element Type | Data Type |
|---|---|
| Parent | - |
This is the root element of the XML request, and is required. This element is empty, and thus contains neither data nor child elements.
The following attributes of the <inINPUT_TOOL> element are defined:
Attributes:
🔹Account,🔹DataDirPath,🔹ForceReload,🔹LoanType
🔹 Account
| Data Type | Values | Default |
|---|---|---|
| Integer | [1...9999] | 1 |
This attribute specifies which account should be used to query user interface
settings. If this attribute is not specified, a default value of 1 will be
used.
🔹 DataDirPath
| Data Type | Values | Default |
|---|---|---|
| Text | See below | See below |
If this attribute is set, the SCE will look for a data folder containing the
setup files in the path specified. Thus, if the DataDirPath is set to
C:\SCEX\, the SCE will look for the setup files in C:\SCEX\data.
If the calling application wishes to specify the data directory path in its
entirety (e.g. the calling app does not want the SCE to append \data to the
provided path), then simply terminate the specified DataDirPath with an
asterisk (*). Thus, if the DataDirPath is set to C:\SCEX\bank1\*, the SCE
will look for the setup files in C:\SCEX\bank1\.
If this attribute is not set, the SCE will attempt to locate the data folder in
the default data directory path location, which can be retrieved using the
<inVERSION> module query, and set via the SCE API.
This attribute is useful if you wish to use only a single installation of the
SCE, but have many different setup file groupings. By specifying a different
DataDirPath for each grouping, you can easily separate the groups from one
another instead of grouping them all together in a single directory.
🔹 ForceReload
| Data Type | Values | Default |
|---|---|---|
| Boolean | true, false, 1, 0 | false |
The SCE caches setup files previously used. This improves performance for
subsequent loan requests using one of the cached accounts. However, if you need
the SCE to reload the setup files for a given request (e.g. you just copied
over new setup files), then you can set this attribute to true and the setup
files will be forced to reload. If left at the default value of false, then
setup files are only reloaded when the SCE notices that one of the setup files
has been modified.
🔹 LoanType
| Data Type | Values | Default |
|---|---|---|
| Enum | [See Table Below] | Equal |
The LoanType attribute asks what kind of repayment plan is associated with the
loan in question. Different loan types will harvest different data from the
setup files.
| LoanType | Explanation | Modules |
|---|---|---|
| Equal | Loans with equal payments | EQUAL_PMT, EQUAL_PROCEEDS and EQUAL_TERM |
| Balloon | Balloon loans | BALLOON_SPECIFY_AMORT, BALLOON_SPECIFY_REGULAR, BALLOON_SPECIFY_FINAL |
| SinglePay | Loans with a single payment | SINGLE_PAYMENT |
| IntOnly | Interest only payments with a final payoff | INTEREST_ONLY |
| PrinPlus | Constant principal + Interest | PRINCIPAL_PLUS_INTEREST |
| SkipsPickups | Skipped payments or Pickup Pmts | SKIPS_PICKUPS |
| SkipsIrregs | Skipped payments or Irregular Pmts | SKIPS_IRREGULARS |
| ARM | Adjustable Rate Mortgages | ARM |
The LoanType attribute specifies the type of loan about which the calling
application wishes to query user interface information. This is necessary
because some user interface options apply to one type of loan, but not another.
As an example, credit life may be allowed on equal and balloon payment loans,
but disallowed on all others. If this attribute is left unspecified, then an
equal loan is assumed.