User Interface Module - Request

The fields of the Data object supported by a Ui module request are defined in alphabetical order below:

🟥 Data

The fields and objects of the Data object supported by a User Interface module request are defined in alphabetical order below:

Fields: 🔹Account, 🔹Compact, 🔹DataPath

Objects:

🔹 Data.Account

The Account field specifies the numeric setup file account number that will be parsed to determine the user interface related response fields. Each account is numbered from 1 to 9,999, and each account corresponds to a set of setup file which define numerous settings which may affect the loan calculation, such as the accrual method, payment protection methods / rates / caps, etc.

🔹 Data.Compact

If this field is set to a value of true, then the SCE will only return response fields if the value of the field is different from the default value.

🔹 Data.DataPath

If this field is set, the SCE will look for a /data folder containing the setup files in the path specified. Thus, if the DataPath is set to /etc/sce, the SCE will look for the setup files in /etc/sce/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 DataPath with an asterisk (*). Thus, if the DataPath is set to /etc/sce/bank1/*, the SCE will look for the setup files in /etc/sce/bank1/.

If this field is not set, the SCE will attempt to located the /data folder in the default data directory path location, which can be retrieved using the Version module.

This field 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 DataPath for each grouping, you can easily separate the groups from one another instead of grouping them all together in a single directory.