Context: Household
...
| Name | Merge Fields |
|---|---|
| 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: { task: _members, type: 'string' },
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) |
...
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 | checkbox on top of the TIC form, shows if this is an annual recertification |
| effdt | 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 mergefields, they're written here to emphasize it's a piece of code or an input/output. Some expressions/mergfields 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 mergefield name - you'll simply place the name of the mergefield 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 mergefield 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 in 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 it's 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 mergefield named "applicationDate" by writing "<<{dateFormat(application, ‘MM/dd/yyyy’)}>>" now that we've established that "applicationDate" mergefield 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".
...