People Variables

The variables in this article are used to reference the different people in your project and automatically fill out documents with the data entered in Build.

The following tables are available in this article:

To set up roles for people in your project, see the Company Setup section in the General Settings article.

Contractor and Architect Variables

Use the variables from the table to generate documents with necessary information about people in your project. For example, you can populate a contact's name or phone number.

Replace x with the type of person to be returned, one of the following: architect, contractor, notary.

Variables Description PCO RFQ COR OCO SCO
{x.name} Returns the company name of the contact.
{x.contact.name} Returns the contact name of the contact.
{x.contact.phone} Returns the contact's primary phone number from their Autodesk ID profile.
{x.contact.email} Returns the email of the listed contact from your general settings.
{x.contact.taxId} Returns the contact's tax ID.

Owner Variables

Use the variables from the table to populate information about an owner in generated documents. For example, you can add the owner's name or phone number.

Variables Description PCO RFQ COR OCO SCO
{owner.name} Returns the company name of the owner.
{owner.contact.name} Returns the contact name of the owner.
{owner.contact.phone} Returns the owner's primary phone number from their Autodesk ID profile.
{owner.erpId} Returns the owner's ERP ID.
{owner.taxId} Returns the owner's tax ID.
{owner.trade} Returns the owner's trade.
{owner.contact.email} Returns the owner's email address from the general settings.
Note: Owner information has to be added in the Project Admin under the General tab within the Companies Setup section.

Recipient Variables

Use the variables from the table to generate documents with information about recipients.

Note: For Main Contract, Budget Payment Application, COR, and OCO, the following variables return the Owner details' contact's data. For Contract, Cost Payment Application, PCO, RFQ, and SCO, these variables return the Supplier details' contact's data.

Replace x with one of the following: mainContract, contract, pco, rfq, cor, oco, sco, payment.

Variables Description
{x.recipient.name} Returns the full name of the recipient.
{x.recipient.firstName} Returns the first name of the recipient.
{x.recipient.lastName} Returns the family name of the recipient.
{x.recipient.email} Returns the email address of the recipient.
{x.recipient.phone} Returns the recipient's primary phone number from their Autodesk ID profile.
{x.recipient.jobTitle} Returns the job title of the recipient of the change order or contract that comes from the user's Autodesk ID profile setting.
{x.recipient.taxId} Returns the tax ID of the recipient.

Recipient, Creator, and Purchaser Variables

Use the variables from the table to generate documents with information about people in your project. For example, you can populate the name of the company that received the change order or the full name of the recipient of the contract. You can use the search at the top of the tables to narrow down results in the tables.

Replace x with one of the following: mainContract, contract, pco, rfq, rco, oco, sco, payment.

Replace y with one of the following: recipient, creator, purchasedBy, supplier.

Variables Description Contract PCO RFQ COR OCO SCO Cost Payment Application
{x.y.email} Returns the email address of the recipient of the change order, contract, or cost payment application.
{x.y.firstName} Returns the first name of the recipient of the change order, contract, or cost payment application.
{x.y.lastName} Returns the family name of the recipient of the change order, contract, or cost payment application.
{x.y.name} Returns the full name of the recipient of the change order, contract, or cost payment application.
{x.y.jobTitle} Returns the job title of the recipient of the change order or contract that comes from the user's Autodesk ID profile setting.
{x.y.company.address.*} Returns the address of the company that received the change order or contract.
{x.y.company.name} Returns the name of the company that received the change order, contract, or cost payment application.
{x.y.phone} Returns the recipient's first phone number from their Autodesk ID profile.
{x.y.company.erpId} Returns the ERP Partner Company ID of the company that received the change order or contract.
{x.y.company.taxId} Returns the tax ID of the company that received the change order or contract.
{x.y.company.phone} Returns the phone number of the company that received the change order or contract.
{x.y.company.description} Returns the description of the company that received the change order or contract.

Notary Variables

Use the variables from the table to populate information about a notary in your generated documents. For example, you can add the name of the company that received the change order or the full name of the recipient of the contract.

Variables Description
{notary.erpId} Returns the notary's ERP ID.
{notary.taxId} Returns the notary's tax ID.
{notary.name} Returns the notary's name.
{notary.originalName} Returns the notary's original name.
{notary.description} Returns the notary's description.
{notary.phone} Returns the notary's phone number.
{notary.trade} Returns the notary's trade.
{notary.category} Returns the notary's category.
{notary.contact} Returns the notary's contact.

Additional Collaborators Variables

Use the variables from the table to generate documents with information about additional collaborators in your project. These variables can be used to access information about companies and contacts added as additional collaborators to various document types.

Variables Description Contract PCO* RFQ COR OCO SCO Budget Payment Application
{oco.additionalCollaborators} Returns the array of additional collaborator companies for the change order.
{#oco.additionalCollaborators}{name}{/} Iterates through the additional collaborator companies in a change order and returns their names.
{#oco.additionalCollaborators}{#contacts}{name}{/contacts}{/} Iterates through contacts of additional collaborator companies and returns their names.
{#oco.additionalCollaborators}{#contacts}{email}{/contacts}{/} Iterates through contacts of additional collaborator companies and returns their email addresses.
{oco.additionalCollaborators[0].name} Returns the name of the first additional collaborator company.
{oco.additionalCollaborators[0].contacts[0].name} Returns the name of the first contact of the first additional collaborator company.
{oco.additionalCollaborators[0].contacts[0].email} Returns the email of the first contact of the first additional collaborator company.
Note: Additional Collaborators variables for PCOs are available when Use Potential Change Order for change order requests is enabled in Project Process settings.

Iterate Additional Collaborators in a Table

You can iterate through the additional collaborators and their contacts to display their details in a table format. See the example:

Company Name Contact Name Contact Email
{#oco.additionalCollaborators}{name}
{#contacts} {name} {email}{/contacts}{/oco.additionalCollaborators}

This example will dynamically populate the table with the names and emails of all additional collaborators and their contacts.

Access the First Additional Company and Its First Contact

To access the first additional collaborator company and its first contact, you can use the following variables:

This example retrieves the name of the first additional collaborator company and the name and email of its first contact.