Return the live custom field configuration to match what is seen in the custom field management UI.
Return the live custom field configuration to match what is seen in the custom field management UI.
Example result:
<result Status="OK"
>
<CustomFieldConfig ReleaseDate="9/15/2021 2:44:43 PM"
>
<CustomField
Id="custLoan27"
Type="Description"
FriendlyDefaultValue=""
DefaultValue=""
DefaultValueLocked="False"
SecondLienSyncType="On Creation"
SecondLienSyncTypeLocked="True"
Status="Live"
MigratedFromFieldClass="Loan"
MigratedFromFieldIndex="1"
MigratedFromFieldName="sCustomField1Desc"
MigratedFrom="Custom Field 1 DescriptionField"
IsMigratedFieldInMainUI="True"
LinkedTo="Custom Field 1 Description (sCustomField1Desc)"
ShowInOQB="True"
UseAlsoInPML="False"
>
<Tab
Name="Loan" /
>
<Tab
Name="Custom Fields 1 - 20" /
>
</CustomField >
<CustomField
Id="custLoan404"
Type="Selection"
FriendlyDefaultValue=""
DefaultValue=""
DefaultValueLocked="False"
SecondLienSyncType="On Creation"
SecondLienSyncTypeLocked="True"
Status="Live"
ShowInOQB="True"
UseAlsoInPML="True"
VisibilityType="All Loans"
ShowInFullPricer="True"
ShowInQuickPricer="False"
ShowInNonQmQuickPricer="False"
UseAlsoInLos="True"
UsedInManagedRules="False"
>
<Tab
Name="Loan" /
>
<Tab
Name="PML - Loan" /
>
<SelectionOptions>
<Option
PmlId="1"
Description="veggies"
Status="deprecated"
/
>
<Option
PmlId="2"
Description="fruits"
Status="active"
/
>
</SelectionOptions>
</CustomField >
</CustomFieldConfig >
</result>
Attributes of all CustomField elements
- Description - The name of the field as it shows in the UI
- Id - The unique id of the field
-
Type - The type of the field
Possible Values:
- Description
- Long Description
- Quantity
- Money
- Date
- Percentage
- YesNo
- Selection
- FriendlyDefaultValue - The friendly default value to display in the UI. Can differ slightly from default value
- DefaultValue - The default value. The UI friendly version is also provided
- DefaultValueLocked - Whether or not the default value is locked or calculated (True | False)
-
SecondLienSyncType - The type of lien syncing for the field
Possible Values:
- SecondLienSyncTypeLocked - Whether or not the second lien sync type is locked (True | False)
-
Status - The status of the field.
Possible Values:
Additional attributes of CustomField elements that are in the Loan tab (have tab with name Loan)
- ShowInOQB - Whether or not to show the field in the Originator Portal (True | False)
- UseAlsoInPML - Whether or not to use the field in PML (True | False)
Additional attributes of CustomField elements that appear in PML (have tab with name PML - Loan)
-
VisibilityType - Which type of loan the custom field is visible on
Possible Values:
- All Loans
- Purchase Loans
- Refinance Loans
- Home Equity Loans
- ShowInFullPricer - Whether or not to show the field in the full pricer (True | False)
- ShowInQuickPricer - Whether or not to show the field in the quick pricer (True | False)
- ShowInNonQmQuickPricer - Whether or not to show the field in the non-QM pricer (True | False)
- UseAlsoInLos - Whether or not to show the field in the LOS (True | False)
- UsedInManagedRules - Whether or not to the field is currently in use by any rules managed by our pricing team (True | False)
Additional attributes of CustomField elements that were migrated from existing custom fields (have tab with name like Custom Fields, Custom Events, or Rate Lock)
-
MigratedFromFieldClass - Which type of page the existing custom field was visible on
Possible Values:
- Loan
- Pml
- Custom Event
- LockDesk
- MigratedFromFieldIndex - The row where this migrated field appeared in the previous UI
- MigratedFromFieldName - The id of the field it was migrated from
- MigratedFrom - A more descriptive name of the field it was migrated from
- IsMigratedFieldInMainUI - Whether or not to show the field in the new custom fields UI (True | False)
- LinkedTo - A more descriptive name of the field this was migrated from
Attributes of Option elements within SelectionOptions (only for custom fields of type Selection)
- PmlId - The id PML uses to index the option
- Description - The value used in the dropdown
-
Status - Whether or not the option is included in the dropdown
Possible Values: