What are Templating Fields?
Templating fields are used throughout FranchiCzar OS to pull information into your various templates. These fields range from "Node" and "User" information (e.g. your name and contact information) and correspond to things like "Activities" and "Tickets" information.
Why Should I use Templating Fields?
Using the built-in templating fields speeds up your process of building out templates and Workflows. These fields allow you to send communications to leads/customers without the worry of having to find and input information that is already stored within FCOS. The templating engine does this for you!
Getting Started
In each section that follows is a comprehensive list of all the templating fields broken down by type and accompanied by a description.
Node: Templating Fields
The term "Node" is used in reference to a record entered into FCOS. These entries include franchisors, franchisees, alliances, facilities, and customers.
| Field | Description/Example |
|---|---|
| {{ node.alliance_name }} | Provides the full name of the alliance member |
| {{ node.city }} | Provides the city field for the node |
| {{ node.code }} | Provides the code field for the node |
| {{ node.date_created }} | Provides the date and time the node was created |
| {{ node.date_updated }} | Provides the date and time the node was last updated |
| {{ node.fields["custom_field_name"] }} | Provides all custom fields for the node (values can be of various types) |
|
{{ node.first_name }} |
Provides the first name of the node |
| {{ node.full_name }} | Provides both the first and last names of a node |
|
{{ node.guid }} |
Provides the Global Unique Identifier for the node |
| {{ node.image_url }} | Provides the image URL for a node, if applicable/available |
|
{{ node.last_name }} |
Provides the last name for the node |
| {{ node.metadata["utm_source"] }} | Provides all metadata collected at the time of creation, corresponding to the node |
| {{ node.primary_email }} | Provides the primary email address for the node |
| {{ node.primary.phone }} | Provides the primary phone number for the node |
| {{ node.sales_status.name }} | Provides the sales status object for the node |
| {{ node.source }} | Provides the listed source of the node |
| {{ node.state }} | Provides the full state name for the node |
| {{ node.tags[0] }} | Provides tags that have been assigned to the node |
|
{{ node.company_name }} |
Provides the company name associated to the node |
Parent: Templating Fields
"Parent" is not in reference to a child's guardian but rather this is the controlling or managing entity of the referenced "Node". These relationships are referenced in the table below.
| Field | Description/Example |
|---|---|
| {{ parent.company_name }} | Provides the specific "Name" of the controlling or managing entity of the entry referenced or the Facility offering a service (e.g. Franchisor is the "parent" to a Franchisee; Facilities is the "parent" to its customers) |
| {{ parent.primary_email }} |
Provides the "primary email" of the controlling or managing entity of the entry referenced or the Facility offering a service (e.g. Franchisor is the "parent" to a Franchisee; Facilities is the "parent" to its customers) |
| {{ parent.primary_phone }} |
Provides the "primary phone" of the controlling or managing entity of the entry referenced or the Facility offering a service (e.g. Franchisor is the "parent" to a Franchisee; Facilities is the "parent" to its customers) |
| {{ parent.state }} |
Provides the "state" (or province/county for Canada/UK) of the controlling or managing entity of the entry referenced or the Facility offering a service (e.g. Franchisor is the "parent" to a Franchisee; Facilities is the "parent" to its customers) |
User: Templating Fields
"User" is simple, this is you, the person logged into FCOS or an assigned user. You would use these fields to make sure that a templated email or text, for example, contains appropriate contact information.
| Field | Description/Example |
|---|---|
| {{ user.company.company_name }} | Indicates the registered FCOS user's associated "company name" |
| {{ user.email_address }} |
Indicates the registered FCOS user's "email address" |
| {{ user.first_name }} |
Indicates the registered FCOS user's "first name" |
| {{ user.full_name }} |
Indicates the registered FCOS user's "full name" |
| {{ user.last_name }} |
Indicates the registered FCOS user's "last name" |
| {{ user.phone1 }} |
Indicates the registered FCOS user's "phone number" |
| {{ user.position }} |
Indicates the registered FCOS user's title or "position" within their organization |
Activity: Templating Fields
"Activities" are in reference to any notes, emails, calls, texts, and/or any other actions corresponding to a node.
Info
All node activities are listed and available from a General Information page.
| Field | Description/Example |
|---|---|
| {{ activity.activity_type }} | Provides the type of activity |
| {{ activity.direction }} | Provides the activity direction (incoming/outgoing) |
| {{ activity.description }} | Provides description (usually the body) of the activity |
| {{ activity.title }} |
Provides the activity's title |
Ticket: Templating Fields
The "ticket" fields are in reference to the FCOS module for users to submit and manage requests to the FranchiCzar team pertaining to the FCOS platform or another supported program.
| Field | Description/Example |
|---|---|
|
{{ ticket.category.name }} |
Indicates the category (generally the platform or Franchisor) of a ticket entered within FCOS |
| {{ ticket.code }} | Indicates the identifying code assigned to a ticket entered within FCOS |
| {{ ticket.date_closed _or_solved }} | Indicates the date that the ticket is "closed" or "solved" by the ticket owner |
| {{ ticket.date_created }} | Indicated the "date" that the ticket is entered into the FCOS ticketing system |
| {{ ticket.date_first_response }} | Indicates the "date" the ticket owner first responds |
| {{ ticket.date_on_hold }} | Indicates the "date" a ticket's status is "on hold" (only applicable if this status is assigned) |
| {{ ticket.date_update }} | Indicates the most recent "date" a ticket is updated |
| {{ ticket.detail.body }} | Indicates the content entered (description) for a ticket within FCOS |
|
{{ ticket.detail.date_created }} |
Indicates the "date" the content or ticket details are created within FCOS |
|
{{ ticket.detail.id }} |
Indicates the details contained within a ticket which can be utilized in an automated workflow |
|
{{ ticket.detail.is_internal }} |
Indicates the details submitted are categorized as internal and only viewable by FranchiCzar staff |
|
{{ ticket.detail.type }} |
Indicates the type of details submitted on the ticket (i.e. internal or external) |
|
{{ ticket.detail.user_created_full_name }} |
Indicates the full name of the FCOS user who submitted the details found within the ticket |
| {{ ticket.id }} | Indicates the unique ID of a ticket entered into FCOS |
| {{ ticket.is_public }} | Indicates if a ticket is "public" (not private) within FCOS |
| {{ ticket.node_name }} | Set during the creation of the ticket and indicates "to whom you are sending [the] new ticket" |
| {{ ticket.regarding_node_name }} | Set during the creation of the ticket and indicates which company or customer the ticket is "regarding" |
| {{ ticket.subject }} | Indicates the "subject" entered for the ticket within FCOS |
| {{ ticket.ticket_priority }} | Indicates the "priority" level set for a ticket (e.g. Low, Normal, or High) |
| {{ ticket.ticket_status }} | Indicates the ticket's "status" (e.g. New, In Review, Planned, In Progress, Completed, or Closed) |
| {{ ticket.user_assigned_full_name }} | Indicates the FCOS user's "full name" assigned to a ticket |
| {{ ticket.user_created_full_name }} | Indicates the FCOS user's "full name" creating a ticket |
| {{ ticket.vote_count }} | Indicates the count of votes received for a ticket promoted to public for other FCOS users to view and vote on |
| {{ ticket.vote_total }} |
Indicates the total number of votes received for a ticket promoted to the public for other FCOS users to view and vote on |