Doorways Supported Merge fields and Docmosis Documentation

PostedSeptember 1, 2021

UpdatedSeptember 2, 2021

ByEmilio Velazquez-Casias

Context: Household

Name	Description
action	Name of last action in household history
carbal	Total A/R Ending Balance for Current Month (Does include Repayment balance)
ha_city	Housing Authority City
ha_csz	Housing Authority City State Zip
ha_email	Housing Authority Email
ha_fax	Housing Authority Fax
ha_name	Housing Authority Name
ha_phone	Housing Authority Phone
ha_state	Housing Authority State
ha_str1	Housing Authority Street 1
ha_str2	Housing Authority Street 2
hh_careof	Head of Household mailing Care/Of
hh_csz	Head of Household mailing city, state, zip
hh_dob	Head of Household Date of Birth
hh_email	Head of Household email
hh_fmlname or lsfmlname	Head of Household full name: First M. Last
hh_fname	Head of Household First Name
hh_lfmname	Head of Household full name: Last, First M.
hh_mname	Head of Household middle name
hh_prphone	Head of Household Primary Phone #
hh_ssn	Head of Household SSN
hh_strapt	Head of Household mailing with with apt no
hh_surname or lssurname	Head of Household surname, including title.
insdtsched	Date of Scheduled Inspection
lastCreditPostedOn	Last Payment Date
newten	Tenant’s Monthly Charge/Rent
nextardt	Date of next annual recertification
ofc_city	Other HA Office City
ofc_csz	Other HA Office City State Zip
ofc_email	Other HA Office Email
ofc_fax	Other HA Office Fax
ofc_name	Other HA Office Name
ofc_phone	Other HA Office Phone
ofc_state	Other HA Office State
ofc_str1	Other HA Office Street 1
ofc_str2	Other HA Office Street 2
oldten	Previous tenant rent amount
outputdate	Current Date
{ DATE \@ “dddd, MMMM d, yyyy” \* MERGEFORMAT }	Use this (with the quotation marks included) to put in a date without a time If copying into existing mergefield then delete pre-existing mergefield code between brackets, leave one space adjacent to each bracket and copy and paste in from the “D” from “DATE” all the way to the “T” on “MERGEFORMAT” → This will display as “Thursday, January 30, 2020” Remove the ‘dddd’ portion to remove the name of the day from the generated output. TIP: Easiest way to achieve desired date format is to highlight an outputdate mergefield, then right click, select “Edit Field…”, under “Field Names” select “Date”, then select your desired date format.
ppu/accountNumber	ppuCode or acctnum
pgmname	Program Name
prjname (Doesn’t work)	Project Name
<<{substring(ppuCode , 0 , 6)}>>	Project Code
totarbal	Total A/R Ending Balance for Current Month (Does include Repayment balance)
typesched	Type of Inspection Scheduled
u_aptno	Unit Apartment Number
u_baths	Unit’s # of Bathrooms
u_bdrms	Unit Size (# of Bedrooms)
u_city	Unit City
u_csz	Unit City State Zip
u_state	Unit State
u_str1	Unit Street Address Line 1
u_strapt	Unit Street Address Line 1 plus Apt Number
u_yrbuilt	Year Built
u_unitNumber	Unit Number
user_email	HA employee/user email
user_fname	HA employee/user first name
user_lname	HA employee/user last name
user_name	HA employee/user name
user_signature	N/A
user_title	HA employee/user title
work_order_table	Iterate over all work order’s tied to a household
members_table	household members table
waiting_list_table	All waiting lists that this household is assigned to
balDueCurrentMonth	Balance for the last 0-30 days
balDue30To60	Balance for the last 30-60 days
balDue60To90	Balance for the last 60-90 days
balDue90To120	Balance for the last 90-120 days
balDueOver120	Balance over 120+ days old
balDueOver90	Balance over 90+ days old.

Context: Member

Name	Merge Fields
First Name	fm_firstName, fm_fname
Last Name	fm_lastName, fm_surname, fm_lname
Middle Name	fm_middleName
Middle Initial	fm_middleInitial
First, Middle, Last Name	fm_fmlname
Last, First, Middle Name	fm_lfmname
SSN	fm_ssn
SSN Masked	fm_ssn_masked
Suffix	fm_suffix
Sex	fm_sex
Date of Birth	fm_dob
Race Description	«rs_fm_race»«description»«es_fm_race»
Race HUD Code	«rs_fm_race»«hudCode»«es_fm_race»
Relation Description	fm_relation.description
Relation HUD Code	fm_relation.hudCode
Ethnicity Description	fm_ethnicity.description
Ethnicity HUD Code	fm_ethnicity.hudCode
Email Address	«rs_fm_emailAddresses»«address»«es_fm_emailAddresses»
Email Address Category	«rs_fm_emailAddresses»«category»«es_fm_emailAddresses»
Address Category	«rs_fm_addresses»«category»«es_fm_addresses»
Address Is Mailing Address	«rs_fm_addresses»«isMailingAddress»«es_fm_addresses»
Address Postal Code	«rs_fm_addresses»«postalCode»«es_fm_addresses»
Address State	«rs_fm_addresses»«state»«es_fm_addresses»
Address City	«rs_fm_addresses»«city»«es_fm_addresses»
Address Unit	«rs_fm_addresses»«unit»«es_fm_addresses»
Address Street Address	«rs_fm_addresses»«streetAddress»«es_fm_addresses»
Phone Number	«rs_fm_phoneNumbers»«number»«es_fm_phoneNumbers»
Phone Number Category	«rs_fm_phoneNumbers»«category»«es_fm_phoneNumbers»
Expense Last Update	«rs_fm_expenses»«lastUpdate»«es_fm_expenses»
Expense Amount	«rs_fm_expenses»«amount»«es_fm_expenses»
Expense Description	«rs_fm_expenses»«description»«es_fm_expenses»
Asset Last Update	«rs_fm_assets»«lastUpdate»«es_fm_assets»
Asset Income	«rs_fm_assets»«assetIncome»«es_fm_assets»
Asset Cash Value	«rs_fm_assets»«cashValue»«es_fm_assets»
Asset Description	«rs_fm_assets»«description»«es_fm_assets»
Income Excluded Amount	«rs_fm_incomes»«excludedAmount»«es_fm_incomes»
Income Amount	«rs_fm_incomes»«amount»«es_fm_incomes»
Income Description	«rs_fm_incomes»«description»«es_fm_incomes»
Income Last Update	«rs_fm_incomes»«lastUpdate»«es_fm_incomes»
Is Veteran	fm_isVeteran
Is Disabled or Handicapped	fm_isDisabledOrHandicap
Co-Head First Name	cohead_fname
Co-Head First, Middle, Last Name	cohead_fmlname
Co-Head Last, First, Middle Name	cohead_lfmname
Spouse First Name	spouse_fname
Spouse First, Middle, Last Name	spouse_fmlname
Spouse Last, First, Middle Name	spouse_lfmname
Spouse Surname	spouse_surname

Context: Work Order

Name	Merge Field
Work Order Number	workOrderNumber
Requested By	requestedBy
Subject	subject
Area Type	areaType
Head First Name	headFirstName
Head Last Name	headLastName
Program Name	programName
Project Name	projectName
Modified By	modifiedBy
Modified On	modifiedOn
Permission To Enter	permissionToEnter
Smoke Detector Was Checked	smokeDetectorWasChecked
Work Completed	workCompleted
Address	address
Closed On	closedOn
Assigned On	assignedOn
Assigned To Name (Staff or Vendor)	assignedToName
Status	status
Priority	priority
Requested On	requestedOn
Comments Created By	«rs_comments»«createdBy»«es_comments»
Comments Created On	«rs_comments»«createdOn»«es_comments»
Comment Body	«rs_comments»«commentBody»«es_comments»
Work Requested	workRequested
PPU	wo_ppu
Tenant Total	wo_tentot
Labor Costs	labor_costs (see table documentation below)
Materials Costs	materials_costs (see table documentation below)
Vendor / Contractor Costs	vendor_contractor_costs (see table documentation below)
Mileage Costs	mileage_costs (see table documentation below)
Other Costs	other_costs (see table documentation below)

Context: Rent Calc

Name	Merge Field
Adjusted Annual Income	adjustedAnnualIncome
Adjusted Monthly Income	adjustedMonthlyIncome
Asset Income	assetIncome
Basic Rent	basicRent
Dependent Deduction	dependentDeduction
Effective Date	effectiveDate
Elderly Or Disabled Deduction	elderlyOrDisabledDeduction
Expenses	expenses
Fair Market Rent	fairMarketRent
Final Rent	finalRent
Gross Household Income	grossHouseholdIncome
Income	income
Minimum Charge	minimumCharge
Maximum Charge	maximumCharge
Net Tenant Charge	netTenantCharge
Note Rate Rent	noteRateRent
Number Of Dependents	numberOfDependents
Rent Limit	rentLimit
Split1	split1
Split2	split2
Split3	split3
Total Annual Expenses	totalAnnualExpenses
Total Deductions	totalDeductions
Total Tenant Payment (TTP)	totalTenantPayment
Total Tenant Payment (TTP) Percentage	ttpPercentage
Unit Number	unitNumber
Unit Street Address	unitStreetAddress
Unit City	unitCity
Unit State	unitState
Unit Postal Code	unitPostalCode
Unit Number Of Bedrooms	unitNumberOfBedrooms
Utility Allowance	utilityAllowance

Context: Waiting List

Name	Merge Field
Name	name
Housing Authority Name	ha_name
Household Assignments	householdAssignments (see table documentation)

Tables

Members Table (Context: Household)

Wrap the following merge fields in a repeating row under the merge field members_table EX: <<rr_members_table>><<er_members_table>>)

Name	Merge Field
First Name	firstName
Middle Name	middleName
Birth Date	birthDate
Suffix	suffix
Alias	alias
Disabled or Handicapped	isDisabledOrHandicap
Veteran	isVeteran
Sex	sex
Masked SSN	ssn
Unmaksed SSN	unmasked_ssn
Relation Description	relation.description
Relation HUD Code	relation.hudCode
Relation Short Name	relation.short
Ethnicity Description	ethnicity.description
Ethnicity HUD Code	ethnicity.hudCode
Citizenship Description	citizenship.description
Citizenship Hud Code	citizenship.hudCode
Created (Date)	created
Email Addresses	«rs_emailAddresses»«address»«es_emailAddresses»
Email Address Category	«rs_emailAddresses»«category»«es_emailAddresses»
Addresses Category	«rs_addresses»«category»«es_addresses»
Address Is Mailing Address	«rs_addresses»«isMailingAddress»«es_addresses»
Address Postal Code	«rs_addresses»«postalCode»«es_addresses»
Address State	«rs_addresses»«state»«es_addresses»
Address City	«rs_addresses»«city»«es_addresses»
Address Unit	«rs_addresses»«unit»«es_addresses»
Address Street Address	«rs_addresses»«streetAddress»«es_addresses»
Phone Number	«rs_phoneNumbers»«number»«es_phoneNumbers»
Phone Number Category	«rs_phoneNumbers»«category»«es_phoneNumbers»
Expense Last Update	«rs_expenses»«lastUpdate»«es_expenses»
Expense Amount	«rs_expenses»«amount»«es_expenses»
Expense Description	«rs_expenses»«description»«es_expenses»
Asset Last Update	«rs_assets»«lastUpdate»«es_assets»
Asset Income	«rs_assets»«assetIncome»«es_assets»
Asset Cash Value	«rs_assets»«cashValue»«es_assets»
Asset Description	«rs_assets»«description»«es_assets»
Income Excluded Amount	«rs_incomes»«excludedAmount»«es_incomes»
Income Amount	«rs_incomes»«amount»«es_incomes»
Income Description	«rs_incomes»«description»«es_incomes»
Income Last Update	«rs_incomes»«lastUpdate»«es_incomes»
Community Service Code	communityServiceCode
Race HUD Code	race.hudCode
Race Description	race.description
is Full Time Student	isFullTimeStudent
Household Member #	memberNumber
Age	age
Tribe Affiliation	tribe
Tribe’s Enrollment Number	enrollmentNumber

Members Assets Table (Context: Household)

Wrap the following merge fields in a repeating row under the merge field members_assets EX: <<rr_members_assets>><<er_members_assets>>

Name	Merge Field
Household Member #	memberNumber
Asset Type	assetType
Cash Value of Asset	cashValue
Annual Income from Asset	assetIncome

Members Income Table (Context: Household)

Wrap the following merge fields in a repeating row under the merge field members_income EX: <<rr_members_income>><<er_members_income>>

Name	Merge Field
Household Member #	memberNumber
Income Type	incomeType
Annual Income from Income	annualIncome
Amount Excluded from Income	excludedAmount
Annual Income adjusted (Excluded Amount subtracted from Annual Income	adjustedAnnualIncome

Members Income Table Groups (Context: Household)

Wrap the following merge fields in repeating row under the merge field members_income_groups EX: <<rr_members_income_groups>><<er_members_income_groups>>

Name	Merge Field
Household Member #	memberNumber
Total Value of Member’s Wages	incomeWages
Total Value of Member’s Pensions	incomePensions
Total Value of Member’s Welfare	incomeWelfare
Total Value of Member’s Other Income	incomeOther

Wrap the following merge fields in a repeating row under the merge field work_order_table EX: <<rr_work_order_table>><<er_work_order_table>>)

Work Order Table (Household Context)

Name	Merge Field
Household’s latest Work Order #	wo_num

Waiting List Table (Household Context)

Name	Merge Field
Waiting List Name	wl_name
Waiting List Application Date	wl_dton

Household Assignments Table (Waiting List Context)

wrap all the following merge fields in a repeating row under the merge field householdAssignments (<<rr_householdAssignments>><<er_householdAssignments)

Name	Merge Field
Rank	$itemnum
Name	household.headLastName, household.headFirstName
Prefer Points	totalPreferencePoints
App Date / Time	applicationDate
Bed	bedroomSize
Num (#) In Fam	numInFam
Income	householdGrossIncome
AMI Pct	percentageOfMedianIncome
Income Level	incomeLevel
Last Update	lastUpdatedDate
Preferences (Name)	<<rs_preferences>><<name>><<es_preferences>>
Preferences (Points)	<<rs_preferences>><<pointValue>> <<es_preferences>>
Modified By	modifiedBy

Labor_Costs Table (Work Order Context)

Name	Merge Field
Charge Type	chargeType
Description	description
Amount	amount
Billable To	billableTo
Hours	hours
Date of Work	dateOfWork

Materials_Costs Table (Work Order Context)

Name	Merge Field
Charge Type	chargeType
Description	description
Amount	amount
Billable To	billableTo
Quantity	quantity
Unit Cost	unitCost

Vendor_Contractor_Costs Table (Work Order Context)

Name	Merge Field
Charge Type	chargeType
Description	description
Amount	amount
Billable To	billableTo
Vendor	vendor
Purchase Order	purchaseOrder

Mileage_Costs Table (Work Order Context)

Name	Merge Field
Charge Type	chargeType
Description	description
Amount	amount
Billable To	billableTo
Total Mileage	totalMileage
Cost Per Mile	costPerMile

Household Action (Household Action Context)

The initial need for this new merge field coordinator and the merge fields it provides is to support Tax Credits including TIC forms/templates and the TTP template.

Name	Merge Field
annual	The checkbox on top of the TIC form shows if this is an annual recertification
effdt	the effective date of the action initiating the TTP or TIC form
fixedRentReason	reason for household’s fixed rent
hh_moveindt	household move-in date
imputedAssetIncome	imputed asset income calculated at the time the action took place
inclimit	current income limit of household per family size
inclimitx140	current income limit of household multiplied by 140% (1.4)
init	checkbox on top of the TIC form shows if this tenant income certification is for an initial move in
isFixedRateRent	does the household have a fixed rate rent
maximumCharge	maximum rent charge allowed
minimumCharge	minimum rent charge allowed
mi_famcnt	count of family members at the time of the move in
mi_inc	total income of the househole at the time of move in
spec	checkbox on top of the TIC form, shows if this is a certification for a reason other than move in or annual recertification
otherdesc	note field used if spec field above it set
passbookRate	imputed asset rate, currently set at 0.06% as defined by HUD
ppuCode	PPU Code/account number
totalAssetIncome	total annual income from assets
totalCashValue	total cash value of assets
totalExpenseAnnual	total annual expenses
totalIncomeAnnualAdjusted	total annual income, adjusted
totalIncomeOther	total value of other income
totalIncomePensions	total value of pensions
totalIncomeWages	total value of wages
totalIncomeWelfare	total value of welfare
ttpFinalRent	final rent charge
ttpFixedRent	household’s fixed rent amount
ttpPercent	total tenant payment percent
utilityAllowance	unit’s utility allowance for household
u_unitNumber	unit number

Tenant Ledger

Mergefields:

“_id”

“accountRecords”

“actionId”

“closingBalances”

“closingDate”

“conveyanceDate”

“deactivatedOn”

“formattedUnitTenantStatus”

“headFirstName”

“headLastName”

“household”

“householdActions”

“moveInDate”

“moveOutDate”

“openingDate”

“ppuCode”

“program”

“programName”

“programType”

“project”

“projectName”

“projectSegmentCode”

“tenantLedgerName”

“unit”

“unitAddress”

“unitCSZ”

“unitNumber”

“unitPPUCode”

“unitSegmentCode”

“unitStreetAddress”

“unitTenantStatus”

“transactions”

“__v”

“numAccountRecords”

“sortField”

Tables:

“accountRecords”

“householdActions”

“transactions”.

accountRecords
“name”

“accountDefinitionId”

“accountId”

“actionId”

“chartOfAccountsId”

“deactivatedOn”

“displayName”

“isAR”

“isPrimary”

“isBadDebt”

“isDeposit”

“isPrincipal”

“programId”

“projectId”

“unitId”

“openingBalance”

“closingBalance”

“transactionIds”

Deposit Report

Deposit Transactions Table
«rr_depositTransactions»/«er_depositTransactions»
«sequenceNumber»
«householdName»
«categoryName»
«subCategoryName»
«amount»

«postedOn»

«accountName»

«ppuCode»

Deposit Groups Table
«rr_depositGroups»/«er_depositGroups»
«groupName»
«groupTotal»

«subGroups»

SubGroups Table
«rr_subGroups»/«er_subGroups»
«subGroupName»
«subGroupTotal»

Non-Table Mergefields
«depositSequence»
«depositCreatedOn»

«depositPostedOn»

«depositTotal»

Docmosis Documentation

*Don’t utilize any quotes on the outside of expressions or merge fields, they’re written here to emphasize it’s a piece of code or an input/output. Some expressions/merge fields may utilize single or double quotes within themselves, these are okay to use and are part of the code.

Using Expressions:

Sometimes an expression will work with the already existing merge field name – you’ll simply place the name of the merge field in the expression.

Other times you may need to establish a variable for the expression to recognize it and be able to use it. In that case, to establish a variable you will place a dollar sign in front of a newly created word.

For example, we have an already existing merge field named “applicationDate” but we need to apply an expression to it to modify it. We will establish a new variable named “application” by writing this at the top of the document (top of the document is the best place as it needs to be read by the system first before being able to be used further below in the document). That looks like this: “$application=applicationDate” (Once again, please don’t use the double quotes when you actually do this, they’re there to emphasize its code or a named variable.) This line of code will automatically be hidden by Word as long as Docmosis accepts it as an established (functioning), new variable. You will then use an expression below this line of code to augment the date from the merge field named “applicationDate” by writing “<<{dateFormat(application, ‘MM/dd/yyyy’)}>>” now that we’ve established that “applicationDate” merge field has been turned into a variable called “application”. Below are some useful expressions for Doorways templates:

Formatting a Monetary Value

myVal = variable name or pre-existing mergefield.

<<myVal{renderer=number(‘$#,##0.00’)}>>

This will change an input such as “1127.4” into “$1,127.40”.

Hiding Mergefields/Text:

Highlight the text, merge field, or expression you’d like to hide then click to expand the font section in word to see further details, navigate to “Effects” and checkmark “Hidden”.

This is useful for quickly removing something from being shown when the document generates it’s output – however, it will remain in the document for future reference. Sometimes you may want to hide a merge field or expression that has to be established in order for a piece of code further in the document to work – you can simply hide these, they will still continue to function but not be shown in the generated output.