{"id":1735,"date":"2019-03-06T10:57:45","date_gmt":"2019-03-06T09:57:45","guid":{"rendered":"https:\/\/help.cirrus-shield.com\/docs\/admin-guide\/template\/template-word-document\/"},"modified":"2019-09-27T13:36:56","modified_gmt":"2019-09-27T12:36:56","slug":"template-word-document","status":"publish","type":"docs","link":"https:\/\/help.cirrus-shield.com\/en\/docs\/admin-guide\/template\/template-word-document\/","title":{"rendered":"Template Word Document"},"content":{"rendered":"
\n
\n
\n
\n

Template Word Document<\/strong><\/span><\/p>\n

To create a template file, we use the office word document<\/strong>.<\/p>\n

In the following, we will show you in details how to generate a template for a quote <\/strong>as an example.<\/span><\/span><\/p>\n

 <\/p>\n

Step 1:<\/strong> Open a new word document.<\/p>\n

Step 2 : <\/strong>Start by writting down all the standard information you have, as the logo, the terms and conditions, etc.<\/p>\n

Step 3:<\/strong> There are 4 types of parameters to know inside your template, in order to display data from Cirrus Shield.<\/p>\n

 <\/p>\n

Before explaining to you the 4 types of parameters, please go to your Cirrus Shield account and log in.<\/strong><\/p>\n

 <\/p>\n

Once you are logged in:<\/span><\/p>\n

    \n
  • Click on Setup<\/strong>.<\/li>\n
  • Go to Objects<\/strong>.\u00a0<\/li>\n
  • Click on the Quote details<\/strong>.<\/li>\n
  • Go to Custom fields\u00a0<\/strong>and find out all the field names <\/strong>you need to use inside your template.<\/li>\n<\/ul>\n

     <\/p>\n

    Now that you have access to all your field names, we can go through the 4 parameters.<\/p>\n

     <\/p>\n

      \n
    1. Data from the main object:<\/span><\/strong><\/li>\n<\/ol>\n

      This type of data, we write it down as the following: {ObjectName.FieldName}.\u00a0<\/strong><\/p>\n

      In our case, the object is the quote<\/span><\/strong> and the field is Bill to Contact, <\/strong>for example : {Quote.Bill_to_Contact}.\u00a0<\/strong><\/p>\n

       <\/p>\n

      \u00a0 \u00a0 \u00a0 \u00a02.<\/span> Data from the Lookup objects of the main object:<\/strong><\/span><\/p>\n

      This type of data, we write it down as the following :{ObjectName.LookupField.FieldName}<\/strong>\u00a0<\/p>\n

      Only for this type of data<\/strong>, we wil base our example on the lead<\/span><\/strong>:\u00a0{Lead.Owner.Username}<\/strong><\/p>\n

       <\/p>\n

      N.B:<\/span> All Lookup Fields, you find next to them a small reaserch icon :<\/strong><\/span><\/p>\n

       <\/p>\n

      \"\"<\/p>\n

       <\/p>\n

      \u00a0 \u00a0 \u00a0 3. Data from the Lookup Multi-Realationships objects of the main object:<\/span><\/strong><\/p>\n

      Going back to our quote<\/span><\/strong> example, this third type of data, we write it down as the following :<\/p>\n

      Your contact : {Quote.OwnerId.User.Name}<\/strong><\/p>\n

       <\/p>\n

      \u00a0 \u00a0 \u00a0 \u00a04. Data from the Related List objects of the main object:<\/span><\/strong><\/p>\n

      For the fourth type of data :<\/p>\n

      {RelatedList.RelatedObjectName.RelatedObjectRelationshipName.FieldName}<\/strong><\/p>\n

       <\/p>\n

      Based on our quote<\/strong><\/span> example:<\/p>\n

      {RelatedList.Quote_Line_Item.Quote_LineItems.Name}<\/strong><\/p>\n

      {RelatedList.Quote_Line_Item.Quote_LineItems.Quantity}<\/strong><\/p>\n

      {RelatedList.Quote_Line_Item.Quote_LineItems.Unit_Price}<\/strong><\/p>\n

      {RelatedList.Quote_Line_Item.Quote_LineItems.Total}<\/strong><\/p>\n

       <\/p>\n

      In the following, we will show you how to find the Related Object Name<\/strong>, the Related Object Relationship Name<\/strong> and the Field Name<\/strong>.<\/p>\n

       <\/p>\n

      \u00a0 \u00a0 \u00a0 \u00a0a- How to find the related object name ?<\/strong><\/span><\/p>\n

        \n
      • Go to Setup<\/strong>.<\/li>\n
      • Click on Objects tab<\/strong>.<\/li>\n
      • Click on the Quote line details<\/strong>.<\/li>\n
      • You get the related object name at the top of the page: ” Quote_Line_Item<\/strong> “.<\/li>\n<\/ul>\n

         <\/p>\n

        \u00a0 \u00a0 \u00a0 \u00a0b- How to find the Related Object Relationship Name ?<\/strong><\/span><\/p>\n

          \n
        • On the same page<\/strong>, click on Custom fields.<\/strong><\/li>\n
        • Click on the Quote details<\/strong>.<\/li>\n
        • Get the relationship name: Quote_LineItems<\/strong>.<\/li>\n<\/ul>\n

           <\/p>\n

          \u00a0 \u00a0 \u00a0 \u00a0c- How to find the field name ?<\/strong><\/span><\/p>\n

          On the cutom fields page, you can find the field names you need for the quote: Quantity, Unit_Price,Total<\/strong>.\u00a0<\/p>\n

           <\/p>\n

          N.B:<\/span> The field name ” Name<\/span> “, you can find it directly after clicking<\/span> on the Quote line details<\/span>.\u00a0<\/span><\/strong><\/p>\n

           <\/p>\n

          On your word document, after writing the fourth data type, follow these steps:<\/p>\n

            \n
          • Select a Field Name (Name for example).<\/strong><\/li>\n
          • Go to Insert<\/strong>.<\/li>\n
          • Click on Bookmark<\/strong>.<\/li>\n
          • Write down the Related Object Relationship Name <\/strong>of the Field Name you chose.\u00a0<\/li>\n
          • Click on Add<\/strong>.<\/li>\n<\/ul>\n

            N.B: <\/strong><\/span><\/span><\/p>\n

              \n
            • You need to repeat these steps listed above for all the field names, only in this data type<\/span> (In our case, for:\u00a0Quantity, Unit_Price and Total).\u00a0<\/span><\/strong><\/li>\n<\/ul>\n

               <\/p>\n

                \n
              • 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.<\/strong><\/span><\/li>\n<\/ul>\n

                 <\/p>\n

                  \n
                • If the Related List object used is not related to the main object, the generated table will not be inserted in the generated template.<\/strong><\/span><\/li>\n<\/ul>\n

                   <\/p>\n

                    \n
                  • To add headers with specific format for the table of the Related List, add a word with a specific format for example as follow:<\/strong><\/span><\/li>\n<\/ul>\n

                    {Headers}<\/strong><\/p>\n

                    Select the header name typed above in the document, go to \u201cInsert\u201d tab, press \u201cBookmark\u201d and add a bookmark in the word document and name it as follow:<\/strong><\/span>
                    RelatedObjectRelationshipName_Headers (ex:<\/u><\/em> LeadTasks_Headers) in order to set the specific format in the generated template.<\/strong><\/span><\/p>\n<\/div>\n<\/div><\/div>\n<\/section>\n

                    <\/p>\n","protected":false},"author":12,"featured_media":0,"parent":1674,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_et_pb_use_builder":"","_et_pb_old_content":"","_et_gb_content_width":"","footnotes":""},"doc_tag":[],"class_list":["post-1735","docs","type-docs","status-publish","hentry"],"comment_count":0,"_links":{"self":[{"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/docs\/1735","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/users\/12"}],"replies":[{"embeddable":true,"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/comments?post=1735"}],"version-history":[{"count":75,"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/docs\/1735\/revisions"}],"predecessor-version":[{"id":3464,"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/docs\/1735\/revisions\/3464"}],"up":[{"embeddable":true,"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/docs\/1674"}],"next":[{"title":"Template Setup","link":"https:\/\/help.cirrus-shield.com\/en\/docs\/admin-guide\/template\/template-setup\/","href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/docs\/1738"}],"wp:attachment":[{"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/media?parent=1735"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/doc_tag?post=1735"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}