Skip to main content

Syngrafii Templating Guide

Syngrafii Support Team
Updated

Contents

  1. Tutorials
  2. What is a Template Tag?
  3. Tags
  4. Tag Options (Advanced)
  5. Tag Data ID
  6. Custom Template Tags

 

Tutorials

A great way to save time for both you and your document signers is to template your existing documents which you generate with template tags.

  • How To Add a Signature Box

    A typical document that requires a signature contains a signature line with additional lines for the signer to print their name and the date they signed the document.

    mceclip1.png

    Let’s automate this by updating our documents with template tags. These tags will be processed by Syngrafii when you create a new package. Syngrafii will replace the tags with a signature box in the exact location the tag was added.

    mceclip2.png

    Note: You may notice that the {{signer_1:signature_1}} tag above has a much larger font. This is because the signature box will be sized to the height and width of the tag by default. You can optionally add advanced options to a tag that will customize the size of the signature box.

    Now when you create a new signing package with the tagged document the signer(s) will be presented with a signature box to sign the document. You will also notice below that the name and date tags have been replaced with the signer’s name and today’s date automatically.

    mceclip3.png

 

What is a Template Tag?

A tag is comprised of one or more sections as described below:

mceclip4.png

Tags have long and short forms for additional space saving in a document.

Assigning a Signer to a Tag
If your document requires signatures from multiple signers you can assign tags to each signer by using signer_1 for the first signer, signer_2 for the second signer, and so on. If you are creating an In Person Signing or a Video Signing Room Package, you can add a tag for the Host by using signer_host, the remaining signers will be numbered. If you do not include a signer tag the first signer will always be assigned the tag.

When to use Tag Ids
It is recommended that you always use a unique tag id when you want to include tag properties such as a signature date or name. This will ensure that the signature date and name is associated with the correct signature.

{{signer_1:signature_1}}
{{signer_1:signature_1_date}}

In the example above the signature is given an id of 1 associating the tags with one another.

{{signer_1:signature_contract}}
{{signer_1:signature_contract_date}}

You can also provide a name as an id, this can be helpful in larger documents where you might lose track of the next number. Try to avoid any special characters however as many will break the tag.

{{signer_1:initials}}

If you do not need to add a property tag, there is no need to include a tag id. In the example above, if there is no need to include the date of the initials, {{signer_1:initials_1_date}}, you can leave out the tag id and let Syngrafii number them for you when the package is created.

 

Tags

    • Signature Box

      Add signature boxes to your template.

       Property   Long  Short  Notes
       Name  {{signer_#:signature_#_name}}   {{s_#:sig_#_name}}   Name of the signer who signed 
       Date  {{signer_#:signature_#_date}}   {{s_#:sig_#_date}}   Date of the signature 

      • Examples

        • Add Signature Box 1 for Signer 1 
          Long        {{signer_1:signature_1}}
          Short       {{s_1:sig_1}}
        • Add Signature Box 1 Date for Signer 1
          Long        {{signer_1:signature_1_date}}
          Short       {{s_1:sig_1_date}}

    • Initials Box

      Add initial boxes to your template.

       Property   Long  Short  Notes
       Name  {{signer_#:initials_#_name}}   {{s_#:init_#_name}}   Name of the signer who initialed 
       Date  {{signer_#:initials _#_date}}   {{s_#:init_#_date}}  Date of the initials 

      • Examples

        • Add Initials Box 1 for Signer 1
          Long        {{signer_1:initials_1}}
          Short       {{s_1:init_1}}

    • Text Box

      Add text boxes to your template.

      • Examples

        • Add Text Box for First Signer
          Long        {{text}}
          Short       {{text}}
        • Add Text Box for Signer 1
          Long        {{signer_1:text}}
          Short       {{s_1:text}}

    • Multiline Text Box

      Add multiline text boxes to your template.

      • Examples

        • Add Multiline Text Box 1 for Signer 1
          Long        {{signer_1:multiline_1}}
          Short       {{s_1:multi_1}}

    • Image Box

      Add image boxes to your template.

      • Examples

        • Add Image Box 1 for Signer 1
          Long        {{signer_1:image_1}}
          Short       {{s_1:img_1}}

    • Date Picker Box

      Add a date picker box to your template. Signer must enter a valid date using the date picker calendar.

      • Examples

        • Add Date Picker Box 1 for Signer 1
          Long        {{signer_1:datepicker_1}}
          Short       {{s_1:dp_1}}

  • Radio Button Group

    Add Radio Button Groups to your template. A signer must select one of the radio buttons in the group unless the radio button group is marked as optional.

    Each radio button in a group will have its own tag. There is also support for group tags to allow you to define group options so that they don’t have to be added to each individual tag. You can place the group tag anywhere in a document and it will not be displayed when the signing is launched. 
    Development Note 
    Each Radio Button tag must have a unique ID across all signers.

    • Examples

      • Add Radio Button Group for Signer 1 without a Group Tag
          • Add Radio Button 1 in Group 1
            Long        {{signer_1:radio_1.1}}
            Short       {{s_1:r_1.1}}
          • Add Radio Button 2 in Group 1
            Long        {{signer_1:radio_1.2}}
            Short       {{s_1:r_1.2}}
      • Add optional Radio Button Group 2 for Signer 1 with a Group Tag
        • Add Radio Button Group Tag (Place the group tag anywhere in the document; it will not be displayed when rendered)
          Long        {{signer_1:radio_2:option_optional}}
          Short       {{s_1:r_2:o_opt}}
        • Add Radio Button 1 in Radio Button Group 2 (Signer tag section not needed)
          Long        {{radio_2.1}}
          Short       {{r_2.1}}
        • Add Radio Button 2 in Radio Button Group 2 (Signer tag section not needed)
          Long        {{radio_2.2}}
          Short       {{r_2.2}}

  • Checkbox Group

    Add a checkbox group to your template.

    Each checkbox in a group will have its own tag. There is also support for group tags to allow you to define group options so that they don’t have to be added to each individual tag. You can place the group tag anywhere in a document and it will not be displayed when the signing is launched. 
    Development Note 
    Each Checkbox tag must have a unique ID across all signers.

    • Examples

      • Add Checkbox Group 1 for Signer 1 without Group Tag
          • Add Checkbox 1 to Checkbox Group 1
            Long        {{signer_1:checkbox_1.1}}
            Short       {{s_1:c_1.1}}
          • Add Checkbox 2 to Checkbox Group 1
            Long        {{signer_1:checkbox_1.2}}
            Short       {{s_1:c_1.2}}
      • Add Checkbox Group 2 for Signer 1 with Group Tag and validation. Signer must select 2 checkboxes in the group for successful validation.
        • Add Checkbox Group Tag (Place the group tag anywhere in the document; it will not be displayed when rendered)
          Long        {{signer_1:checkbox_2:validate_required_2}}
          Short       {{s_1:c_2:vd_req_2}}
        • Add Checkbox 1 in Checkbox Group 2 with default value checked (Signer tag section not needed)
          Long        {{checkbox_2.1:value_true}}
          Short       {{c_2.1:v_true}}
        • Add Checkbox 2 in Checkbox Group 2 (Signer tag section not needed)
          Long        {{checkbox_2.2}}
          Short       {{c_2.2}}
        • Add Checkbox 3 in Checkbox Group 2 (Signer tag section not needed)
          Long        {{checkbox_2.3}}
          Short       {{c_2.3}}

  • Document Properties

    Add document properties to your template.

     Property   Long  Short  Notes
     Package Name   {{document:packageName}}   {{doc:packageName}}   
     Name   {{document:name}}   {{doc:name}}   
     Date Signed   {{document:date}}   {{doc:d}}   Date the document was signed by the first signer 

    • Examples

      • Add Document Name
        Long        {{document:name}}
        Short       {{doc:name}}

  • Signer Properties

    Add signer properties to your template.

     Property   Long  Short  Notes
     Name  {{signer_#:name}}   {{s_#:name}}   
     Date Signed  {{s_#:date}}   {{s_#:d}}   Date the document was signed by the signer. You can also customize the date format, see format options below. 

        • Date Property Formatting

          You can customize the signer date by adding format options to it.

           Option   Long  Short

           Output Example
           (English-Canada Locale)
           Date (Default)  {{s_#:date}}   {{s_#:d}}   2022-11-21
           Date Time  {{s_#:date_datetime}}   {{s_#:d_dt}}   2022-11-21 2:25 PM
           Time  {{s_#:date_time}}   {{s_#:d_t}}   2:25 PM
           Time Long  {{s_#:date_timelong}}   {{s_#:d_tl}}   2:25:50 PM
           Day  {{s_#:date_day}}   {{s_#:d_dy}}   21
           Day With Suffix  {{s_#:date_daywithsuffix}}   {{s_#:date_dws}}   21st
           Day Of Week
          		  {{s_#:date_dayofweek}}   {{s_#:d_dow}}   Monday
           Day Of Week Short  {{s_#:date_dayofweekshort}}   {{s_#:d_dows}}   Mon
           Month  {{s_#:date_month}}   {{s_#:d_m}}   11
           Month Short  {{s_#:date_monthshort}}   {{s_#:d_ms}}   Nov
           Month Long  {{s_#:date_monthlong}}   {{s_#:d_ml}}   November
           Year  {{s_#:date_year}}   {{s_#:d_y}}   2022
           Year Short  {{s_#:date_yearshort}}   {{s_#:d_ys}}   22
           Year Month  {{s_#:date_yearmonth}}   {{s_#:d_ym}}   November 2022

        • Examples

          • Add Name of Signer 1
            Long        {{signer_1:name}}
            Short       {{s_1:name}}

 

Tag Options (Advanced)

You can customize the appearance and position of many tags or make them optional by adding additional options to them.

 Option  Long  Short  Notes
 Width  option_width_###   o_w_###   Units @ 72dpi 
 Height  option_height_###   o_h_###   Units @ 72dpi 
 Font Size  option_fontsize_##   o_fs_##   Units @ 72dpi 
 Align to Left  option_align_left   o_a_l  
 Align to Center  option_align_center   o_a_c  
 Alight to Right  option_align_right   o_a_r  
 Optional  option_optional  o_opt  
 Offset

 offset_(x,y)

 or

 offset_x,y

 f_(x,y)

 or

 f_x,y

 Units @ 72dpi

 Offset position of the tag
 Size

 size_(width###,
 height###)

 sz_(width###,
 height###)

 Like the individual Width and Height options but allowing you to accomplish sizing in one tag Units @ 72dpi
 Value

 value_###

 v_###

 Default Value can be set for Text, Multiline, Radio Button & Checkbox tags. See section 4.2 for examples.

  • Units

    When adding custom width, height, or font size the units are scaled at 72dpi. For example, 1 inch would be equal to 72, and 2 inches would be equal to 144. A standard letter size document is 8.5 x 11 inches, or 612 x 792.

  • Examples

    • Custom Signature Width and Height

      Long        {{signer_1:signature_1:option_width_200:option_height_30}}
      Short       {{s_1:sig_1:o_w_200:o_h_30}}

    • Custom Initials Width, Height, and Aligned to Right

      Long        {{signer_1:initials:option_width_40:
                           option_height_40:option_align_right}}
      Short       {{s_1:init:o_w_40:o_h_40:o_a_r}}

    • Initial Every Page in a Document

      To add initials to the footer of your document so that the signer must initial each page you can add option_align_right to force the position of the initials box to the right side of the tag.

      mceclip0.png

      mceclip1.png

    • Optional Signature

      To add an optional signature tag to your document you can add option_optional or o_opt. Initial and Textbox tags can also be made optional.

      mceclip1.png

      mceclip2.png

    • Offsets

      To offset the position of a radio button, for example, you can add offset_(x,y)/offset_x,y or f_(x,y)/f_x,y. Offsets can be added to any tag.

    • Set Checkbox value "checked"

      Long        {{signer_1:checkbox_1.1:value_true}}
      Short       {{s_1:c_1.1:v_true}}

    • Set Radio Button value “selected”

      Long        {{signer_1:radio_1.1:value_true}}
      Short       {{s_1:r_1.1:v_true}}

    • Set Text default value

      Long        {{signer_1:text_1:value_xyz}}
      Short       {{s_1:text_1:v_xyz}}

    • Set height 30 and width 200 of text using size tag option

      Long        {{signer_1:text_1:size_(200,30)}}
      Short       {{s_1:text_1:sz_(200,30)}}

Tag Data ID

Data ID is a unique identifier that can be assigned to Text Box and Multiline Textbox template fields. Data ID can be used by integrators to set and retrieve fields present in documents.

  • Examples

    • Add Data ID “text1” for Text Box

      Long        {{signer_1:text:dataid_text1}}
      Short       {{s_1:text_1:id_text1}}

    • Add Data ID “multiline1” for Mutliline Text Box

      Long        {{signer_1:multiline:dataid_multiline1}}
      Short       {{s_1:multi:id_multiline1}}

Custom Template Tags

Custom template tags are a powerful feature that allows you to add organization-specific custom fields to your documents as tags.

  • What is a Custom Template Tag?

    Unlike standard template tags, which are enclosed in double braces {{tag}}, custom template tags are enclosed in triple braces {{{tag}}}. It is comprised of two sections as described below:

  • Creating a Custom Field with Template Tag

    Creating a custom field with a template tag is a straightforward process. To get started, navigate to the "My Account" section. Ensure that the "Access" setting is configured as "Organization" to add a template tag to a custom field.

  • Valid Template Tag Values: Alphanumeric Characters Only

    When working with template tags, it is important to note that the values assigned to these tags can only contain alphanumeric characters. Alphanumeric characters include letters (both uppercase and lowercase) and numbers (0-9). Special characters, symbols, or spaces are not allowed within the template tag values.

  • Template Tag Preview

    Once you have created a custom field and selected the desired template tag, you have two options for obtaining the actual tag to be placed in the document through the Template Tag Preview. The first option is to utilize the "Copy" button provided in the Template Tag Preview. By clicking this button, the template tag will be automatically copied to your clipboard, ready to be pasted into the document. Alternatively, you can manually copy the tag from the interface and insert it into the document.

  • Streamlining Document Customization with Custom Template Tags

    It's important to note that all the options selected for the custom field will be utilized in the rendered field within the document. This functionality offers a convenient way to incorporate fully customizable custom field types with complex configurations and settings into your documents.

  • Examples

    • Add a Custom Field with Template Tag value “ctag” for Signer 1

      Long        {{{signer_1:ctag}}}
      Short       {{{s_1:ctag}}}

    • Add Custom Field with Template Tag value “customtagvalue” for Signer 2

      Long        {{{signer_2:customtagvalue}}}
      Short       {{{s_2:customtagvalue}}}

 

 

Related articles

Powered by Zendesk