Use this article to identify supported custom tabs on Hireology-connected DocuSign templates for the classic eSignature offer letter. Each field below is populated automatically from Hireology data when the envelope is created.
In this article we will cover:
- How custom tab fields are populated
- Profile fields
- Candidate address and phone fields
- Employment fields
- Company fields
- Job fields
- Compensation fields
- Related Topics
How custom tab fields are populated
Custom tab fields use a DocuSign data label. Add the exact data label shown below to the matching custom field on the DocuSign template. Hireology maps the field to candidate, hiring manager, company, job, or compensation data as described in each entry.
Employee and Hiring Manager fields resolve from the recipient’s own profile. The Hiring Manager receives a value only when the hiring manager record has one; among profile fields, name and email are the values generally available for that recipient. Candidate address fields are populated only for the Employee.
Company, job, and compensation values are resolved globally and applied to all signers. Company and Job tabs are read-only by convention. Start Date is also read-only. Global values can also populate template prefill fields.
Profile fields
These fields resolve for the Employee and Hiring Manager from the recipient’s own profile, subject to available profile data.
- DocuSign data label: profile.email
- What it populates: The recipient’s email address on file. Populated for Employee and Hiring Manager.
First Name
- DocuSign data label: profile.firstName
- What it populates: The recipient’s first name. Populated for Employee and Hiring Manager.
Last Name
- DocuSign data label: profile.lastName
- What it populates: The recipient’s last name. Populated for Employee and Hiring Manager.
Full Name
- DocuSign data label: profile.fullName
- What it populates: The recipient’s first and last name joined with a space. Populated for Employee and Hiring Manager.
Candidate address and phone fields
These fields populate only on the Employee’s copy of the document. Address values come from the candidate’s profile.
Full Address
- DocuSign data label: profile.address.fullAddress
- What it populates: The candidate’s street, city, state, and ZIP combined into one line.
Street Address
- DocuSign data label: profile.address.streetAddress
- What it populates: Address line 1 from the candidate’s profile.
Address 1
- DocuSign data label: profile.address.address1
- What it populates: Address line 1, unformatted.
City
- DocuSign data label: profile.address.city
- What it populates: City from the candidate’s profile.
State
- DocuSign data label: profile.address.state
- What it populates: State code from the candidate’s profile.
Postal Code
- DocuSign data label: profile.address.postalCode
- What it populates: ZIP or postal code from the candidate’s profile.
City, State, and Zip
- DocuSign data label: profile.address.cityStateZip
- What it populates: City, state, and ZIP combined into one line.
Phone Number
- DocuSign data label: profile.phoneNumber
- What it populates: The candidate’s home phone if present; otherwise, the candidate’s cell phone.
Employment field
Start Date
- DocuSign data label: employment.startDate
- What it populates: The candidate’s job start date in MM/DD/YYYY format. The same start date is applied to every signer, regardless of role, and to template prefill sender fields. The DocuSign tab is read-only.
Company fields
Company values are resolved once and applied to every signer, including roles beyond Employee and Hiring Manager. Company tabs are read-only by convention. These values also map to template prefill fields.
Company Name
- DocuSign data label: company.name
- What it populates: Name of the hiring organization.
Full Address
- DocuSign data label: company.address.fullAddress
- What it populates: Organization street, city, state, and ZIP combined into one line.
Street Address
- DocuSign data label: company.address.streetAddress
- What it populates: Organization address line 1 and address line 2 joined.
Address 1
- DocuSign data label: company.address.address1
- What it populates: Organization address line 1.
Address 2
- DocuSign data label: company.address.address2
- What it populates: Organization address line 2.
City
- DocuSign data label: company.address.city
- What it populates: Organization city.
State
- DocuSign data label: company.address.state
- What it populates: Organization state code.
Postal Code
- DocuSign data label: company.address.postalCode
- What it populates: Organization ZIP or postal code.
City, State, and Zip
- DocuSign data label: company.address.cityStateZip
- What it populates: Organization city, state, and ZIP combined into one line.
Job fields
Job values are resolved globally alongside Company values and are read-only by convention.
Job Title
- DocuSign data label: job.title
- What it populates: Title of the job the candidate was hired into.
Department
- DocuSign data label: job.department
- What it populates: Department associated with the job.
Compensation fields
Compensation fields are populated only when compensation prefill is enabled for the organization. Until it is enabled, these fields render blank. For a compensation range, Pay Rate shows the low end of the range, not the full range. Compensation values are applied to all signers and template prefill sender fields.
Pay Rate
- DocuSign data label: compensation.payRate
- What it populates: The job’s pay rate formatted as currency (for example, $25.00). For a range, this is the low end.
Pay Period
- DocuSign data label: compensation.payPeriod
- What it populates: The pay period configured on the job (for example, Hour or Year).
Pay Frequency
- DocuSign data label: compensation.payFrequency
- What it populates: How often pay is issued (for example, Weekly, Bi-Weekly, or Monthly).
Pay Rate and Period
- DocuSign data label: compensation.payRateAndPeriod
- What it populates: Pay Rate and Pay Period combined on one line (for example, $25.00 / Hour).
Pay Rate and Period and Frequency
- DocuSign data label: compensation.payRateAndPeriodAndFrequency
- What it populates: Pay Rate, Pay Period, and Pay Frequency combined on one line (for example, $25.00 / Hour, paid Bi-Weekly).
Related Topics:
- How do I create and send a PDF offer letter with classic eSignature?
- What are Enhanced Offer Letters, and which offer-letter method should I use?
Comments
0 comments
Please sign in to leave a comment.