Use object type fields in field control expressions to pull information from an associated object.

When you add field controls to a question in a form, you might want to refer to data about the object type that you are running the business process or call script on. For example, if you want to show a question only if a contact is married, you can create a field control expression that checks the Marital Status field of the contact.

One way to do this is to create a question in the form, bind it to the desired field from the object type, then use a form field to refer to the question. If you want to refer to object type information without creating and binding additional form questions, you can instead use object type fields.

When you use an object type field in an expression, it is important to note the listed date type of the field. If the object type field is being used to set the value of an answer in the form, the data type of the field must match the expected data type of the answer. If the object type field is being used as an argument in a function or expression, the data type of the field must match the expected data type of the argument. When you use an object type field in an expression, it is important to note the listed date type of the field. If the object type field is being used to set the value of an answer in the form, the data type of the field must match the expected data type of the answer. If the object type field is being used as an argument in a function or expression, the data type of the field must match the expected data type of the argument.

Contact fields

Contact fields take their values from the contact or user object type on which you are running the business process or call script. The following contact fields are available for you to use in field control formulas:
Note: If you run the business process or call script on a KYC object type and would like to access a contact field from the contact or user, use the syntax @client.<field_name>.

Contact fields for use in field control expressions

Field Name	Data Type	Field Caption
@affix	String	Affix
@birthTime	Date	Date of Birth
@businessAddressAddress1	String	Business Address Address 1
@businessAddressAddress2	String	Business Address Address 2
@businessAddressAttention	String	Business Address Attention
@businessAddressCity	String	Business Address City
@businessAddressCountryValue	Enumeration	Business Address Country
@businessAddressDeliveryInstructions	String	Business Address Delivery Instructions
@businessAddressDescription	String	Business Address Description
@businessAddressState	String	Business Address State
@businessAddressZip	String	Business Address Zip
@businessAddressZipPlusFour	String	Business Address Zip +4
@companyName	String	Company
@dear	String	Dear
@defaultLang	String	Language
@departmentName	String	Department
@emailAddress	String	Email Address
@emailDescription	String	Email Description
@entityStatus	Enumeration	Status
@firstName	String	First Name
@genderCode	Enumeration	Gender
@goesBy	String	Goes by
@homeAddressAddress1	String	Home Address Address 1
@homeAddressAddress2	String	Home Address Address 2
@homeAddressAttention	String	Home Address Attention
@homeAddressCity	String	Home Address City
@homeAddressCountryValue	Enumeration	Home Address Country
@homeAddressDeliveryInstructions	String	Home Address Delivery Instructions
@homeAddressDescription	String	Home Address Description
@homeAddressState	String	Home Address State
@homeAddressZip	String	Home Address Zip
@homeAddressZipPlusFour	String	Home Address Zip +4
@homePhoneDescription	String	Home Phone Description
@homePhoneExtension	String	Home Phone Extension
@homePhoneNumber	String	Home Phone Number
@initials	String	Initials
@lastName	String	Last Name
@notes	String	Bio
@position	String	Position
@ssn	String	SSN
@tier	Enumeration	Tier
@title	String	Title
@workPhoneDescription	String	Business Phone Description
@workPhoneExtension	String	Business Phone Extension
@workPhoneNumber	String	Business Phone Number

Category fields

Categories are extra information or classifications that can be given to a contact. Category fields take their values from the contact or user object type on which you are running the business process or call script. The following default category fields are available for you to use in expressions:

Categories are defined in Categories in the Customize workspace. You can also use additional categories that have been defined in the Categories tab. Access additional categories using the token @_cat_., followed by the name of the category, written in upper case letters and with all spaces replaced with underscores.

If you run the business process or call script on a KYC object type and would like to access a category field from the contact or user, use the syntax @client.<field_name>.

Category fields for use in field control expressions

Field Name	Data Type	Field Caption
@_cat_.AUTOMOBILE	Boolean	Automobile
@_cat_.AVID_GOLFER	Boolean	Avid Golfer
@_cat_.BASEBALL_FAN	Boolean	Baseball Fan
@_cat_.BASKETBALL_FAN	Boolean	Basketball Fan
@_cat_.BONDS	Boolean	Bonds
@_cat_.BOP	Boolean	BOP
@_cat_.BUSINESS_AT_RISK	Boolean	Business at Risk
@_cat_.CHANGING_MARITAL_STATUS	Boolean	Changing Marital Status
@_cat_.COMMERCIAL_AUTO	Boolean	Commercial Auto
@_cat_.COMMERCIAL_GENERAL_LIABILITY	Boolean	Commercial General Liability
@_cat_.COMMERCIAL_PROPERTY	Boolean	Commercial Property
@_cat_.COMMODITIES	Boolean	Commodities
@_cat_.COMPANY_CATEGORY__CORPORATION	Boolean	Company Category - Corporation
@_cat_.COMPANY_CATEGORY__GOVERNMENT	Boolean	Company Category - Government
@_cat_.COMPANY_CATEGORY__TAX_EXEMPT	Boolean	Company Category - Tax Exempt
@_cat_.CONSUMER_GOODS	Boolean	Consumer Goods
@_cat_.DEFINED_BENEFITS	Boolean	Defined Benefits
@_cat_.DEFINED_CONTRIBUTION	Boolean	Defined Contribution
@_cat_.DO_NOT_MAIL	Boolean	Do Not Mail
@_cat_.ENDOWMENTS	Boolean	Endowments
@_cat_.ENERGY	Boolean	Energy
@_cat_.EQUITIES	Boolean	Equities
@_cat_.ESTATE_PLANNING	Boolean	Estate Planning
@_cat_.FINANCIAL_PLANNING	Boolean	Financial Planning
@_cat_.FINANCIAL_SERVICES	Boolean	Financial Services
@_cat_.FIXED_INCOME	Boolean	Fixed Income
@_cat_.FOUNDATIONS	Boolean	Foundations
@_cat_.GETTING_MARRIED	Boolean	Getting Married
@_cat_.GLOBAL_EQUITIES	Boolean	Global Equities
@_cat_.GROWTH_STOCKS	Boolean	Growth Stocks
@_cat_.HAS_CHILDREN	Boolean	Has Children
@_cat_.HEALTHCARE	Boolean	Healthcare
@_cat_.HIGH_NET_WORTH	Boolean	High Net Worth
@_cat_.HIGH_PREMIUM	Boolean	High Premium
@_cat_.HOCKEY_FAN	Boolean	Hockey Fan
@_cat_.HOLIDAY_CARD	Boolean	Holiday Card
@_cat_.HOME	Boolean	Home
@_cat_.INSTITUTIONAL_INVESTOR	Boolean	Institutional Investor
@_cat_.INSURANCE	Boolean	Life Insurance
@_cat_.INVESTING_IN_GOLD_SYMPOSIUM_INVITE	Boolean	Investing in Gold Symposium Invite
@_cat_.JOB_CHANGE_PROMOTION	Boolean	Job Change/Promotion
@_cat_.MANUFACTURING	Boolean	Manufacturing
@_cat_.MULTI_PRODUCT_CLIENT	Boolean	Multi Product Client
@_cat_.OIL_AND_GAS	Boolean	Oil & Gas
@_cat_.PRECIOUS_METALS	Boolean	Precious Metals
@_cat_.RETIREMENT_PLANNING	Boolean	Retirement Planning
@_cat_.SENDING_TEEN_TO_COLLEGE	Boolean	Sending Teen to College
@_cat_.SERVICES	Boolean	Services
@_cat_.SPECIALTIES__CORPORATE	Boolean	Specialties - Corporate
@_cat_.SPECIALTIES__ENDOWMENTS	Boolean	Specialties - Endowments
@_cat_.SPECIALTIES__FOUNDATIONS	Boolean	Specialties - Foundations
@_cat_.SPECIALTIES__GOVERNMENT	Boolean	Specialties - Government
@_cat_.SPECIALTIES__PRIVATE_CLIENT	Boolean	Specialties - Private Client
@_cat_.STARTING_BUSINESS	Boolean	Starting Business
@_cat_.STARTING_FAMILY	Boolean	Starting Family
@_cat_.TECHNOLOGY	Boolean	Technology
@_cat_.TERM_LIFE	Boolean	Term Life
@_cat_.UNIVERSAL_LIFE	Boolean	Universal Life
@_cat_.UTILITIES	Boolean	Utilities
@_cat_.VALUABLES	Boolean	Valuables
@_cat_.VARIABLE_UNIVERSAL_LIFE	Boolean	Variable Universal Life
@_cat_.VIP_CLIENT	Boolean	VIP Client
@_cat_.WATERCRAFT	Boolean	Watercraft
@_cat_.WHOLE_LIFE	Boolean	Whole Life

Custom fields

Custom fields store supplementary information that is not otherwise represented in the contact. Custom fields take their values from the contact or user object type on which you are running the business process or call script. The following default custom fields are available for you to use in expressions:

Custom fields are defined in Custom Fields in the Customize workspace. You can also use additional custom fields that have been defined in the Custom Fields tab. Access additional custom fields using the token @_cf_., followed by the name of the custom field, written in upper case letters and with all spaces replaced with underscores.

If you run the business process or call script on a KYC object type and would like to access a custom field from the contact or user, use the syntax @client.<field_name>.

Custom fields for use in field control expressions

Field Name	Data Type	Field Caption
@_cf_.ACCOUNTANT	Object	Accountant
@_cf_.AGENCY_PARTNERSHIP	Object	Agency Partnership
@_cf_.ANNUAL_INCOME	Number	Annual Income
@_cf_.ANNUAL_REVENUE	Number	Annual Revenue
@_cf_.ASSISTANT	Object	Assistant
@_cf_.BEST_TIME_TO_CALL	String	Best Time to Call
@_cf_.BOARD_MEMBER1	Object	Board Member
@_cf_.CAPTIVE_CHANNEL	Object	Captive Channel
@_cf_.CLIENT_TYPE	String	Client Type
@_cf_.CONSULTANT	Object	Consultant
@_cf_.CONSULTANT1	Object	Consultant
@_cf_.COUNTRY_OF_INCORPORATION	String	Country of Incorporation
@_cf_.CREDIT_RATING	String	Credit Rating
@_cf_.CUSTODIAN	Object	Custodian
@_cf_.DATE_OF_MARRIAGE	Date	Wedding Date
@_cf_.EXPIRY_DATE	Date	Expiry Date
@_cf_.FAVOURITE_SPORTS_TEAM	String	Favourite Sports Team
@_cf_.FINANCIAL_INTEREST	String	Financial Interest
@_cf_.FRIEND	Object	Friend
@_cf_.INDEPENDENT_CHANNEL	Object	Independent Channel
@_cf_.LAWYER	Object	Lawyer
@_cf_.LEGAL_STATUS	String	Legal Status
@_cf_.MARITAL_STATUS	String	Marital Status
@_cf_.NET_WORTH	Number	Net Worth
@_cf_.NUMBER_OF_EMPLOYEES	Number	Number of Employees
@_cf_.PERSONAL_INTEREST	String	Personal Interest
@_cf_.PLANNED_RETIREMENT_YEAR	String	Planned Retirement Year
@_cf_.POWER_OF_ATTORNEY	Object	Power of Attorney
@_cf_.REFERRED_BY	Object	Referral
@_cf_.RELATED_HOUSEHOLD	Object	Related Household
@_cf_.TERRITORY	String	Territory
@_cf_.TOTAL_ASSETS	Number	Total Assets
@_cf_.YEAR_OF_ESTABLISHMENT	Date	Year of Establishment
@_cf_.YEARS_INSURED	String	Years Insured

KYC fields

KYC fields take their values from the KYC object type on which you are running the business process or call script. The following KYC fields are available for you to use in expressions:

If you run the business process or call script on a KYC object type and would like to access information from the contact or user, use the alternate notation @client.<field_name>.

KYC fields for use in field control expressions

Field Name	Data Type	Field Caption
@annualIncome	Enumeration	Annual Income
@citizenship	Enumeration	Citizenship
@createDate	Date	Effective Date
@description	String	Description
@expAltInvestments	Boolean	Alternate Investments Experience
@expBonds	Boolean	Bonds Experience
@expCommodities	Boolean	Commodities Experience
@expInterestRates	Boolean	Interest Rates Experience
@expLstDerivatives	Boolean	Listed Derivatives Experience
@expMarginLending	Boolean	Margin Lending Experience
@expMarginTrading	Boolean	Margin Trading Experience
@expMoneyMarketGIC	Boolean	Money Market or GIC Experience
@expNewShares	Boolean	New Shares Experience
@expOptions	Boolean	Options Experience
@expPreciousMetals	Boolean	Precious Metals Experience
@expPrefShares	Boolean	Preferred Shares Experience
@expRealEstate	Boolean	Real Estate Experience
@expShortSelling	Boolean	Short Selling Experience
@govOwnedBusiness	Enumeration	Does the client have a substantial beneficial ownership...
@idCountry	Enumeration	Country of ID
@idType	Enumeration	Type of ID used for verification
@idVerified	Enumeration	Has the client's ID been verified?
@investmentKnowledge	Enumeration	Investment Knowledge
@maritalStatus	Enumeration	Marital Status
@netFixedAssets	Number	Net Fixed Assets
@netLiquidAssets	Number	Net Liquid Assets
@netWorth	Number	Net Worth
@nonProfitOrg	Enumeration	Is the client a part of or member of a non-profitable organization?
@numDependents	Integer	Number of Dependents
@numYearsInvesting	Integer	Number of Years Investing
@portfolioRisk	Enumeration	Portfolio Risk Level
@primaryBank	String	Primary Bank Name
@primaryBankAddr	String	Primary Bank Address
@resOtherCountries	Enumeration	Does the client maintain residences in any other countries?