Template Word Document
To create a template file, we use the office word document.
In the following, we will show you in details how to generate a template for a quote as an example.
Step 1: Open a new word document.
Step 2 : Start by writting down all the standard information you have, as the logo, the terms and conditions, etc.
Step 3: There are 4 types of parameters to know inside your template, in order to display data from Cirrus Shield.
Before explaining to you the 4 types of parameters, please go to your Cirrus Shield account and log in.
Once you are logged in:
- Click on Setup.
- Go to Objects.
- Click on the Quote details.
- Go to Custom fields and find out all the field names you need to use inside your template.
Now that you have access to all your field names, we can go through the 4 parameters.
- Data from the main object:
This type of data, we write it down as the following: {ObjectName.FieldName}.
In our case, the object is the quote and the field is Bill to Contact, for example : {Quote.Bill_to_Contact}.
2. Data from the Lookup objects of the main object:
This type of data, we write it down as the following :{ObjectName.LookupField.FieldName}
Only for this type of data, we wil base our example on the lead: {Lead.Owner.Username}
N.B: All Lookup Fields, you find next to them a small reaserch icon :
3. Data from the Lookup Multi-Realationships objects of the main object:
Going back to our quote example, this third type of data, we write it down as the following :
Your contact : {Quote.OwnerId.User.Name}
4. Data from the Related List objects of the main object:
For the fourth type of data :
{RelatedList.RelatedObjectName.RelatedObjectRelationshipName.FieldName}
Based on our quote example:
{RelatedList.Quote_Line_Item.Quote_LineItems.Name}
{RelatedList.Quote_Line_Item.Quote_LineItems.Quantity}
{RelatedList.Quote_Line_Item.Quote_LineItems.Unit_Price}
{RelatedList.Quote_Line_Item.Quote_LineItems.Total}
In the following, we will show you how to find the Related Object Name, the Related Object Relationship Name and the Field Name.
a- How to find the related object name ?
- Go to Setup.
- Click on Objects tab.
- Click on the Quote line details.
- You get the related object name at the top of the page: ” Quote_Line_Item “.
b- How to find the Related Object Relationship Name ?
- On the same page, click on Custom fields.
- Click on the Quote details.
- Get the relationship name: Quote_LineItems.
c- How to find the field name ?
On the cutom fields page, you can find the field names you need for the quote: Quantity, Unit_Price,Total.
N.B: The field name ” Name “, you can find it directly after clicking on the Quote line details.
On your word document, after writing the fourth data type, follow these steps:
- Select a Field Name (Name for example).
- Go to Insert.
- Click on Bookmark.
- Write down the Related Object Relationship Name of the Field Name you chose.
- Click on Add.
N.B:
- You need to repeat these steps listed above for all the field names, only in this data type (In our case, for: Quantity, Unit_Price and Total).
- If there is no bookmark added or the bookmark name was not in the right format, the generated table will not be inserted in the generated template.
- If the Related List object used is not related to the main object, the generated table will not be inserted in the generated template.
- To add headers with specific format for the table of the Related List, add a word with a specific format for example as follow:
{Headers}
Select the header name typed above in the document, go to “Insert” tab, press “Bookmark” and add a bookmark in the word document and name it as follow:
RelatedObjectRelationshipName_Headers (ex: LeadTasks_Headers) in order to set the specific format in the generated template.
