MS Word eSigning Templates

Prepare document in MS Word

1.Prepare document which should be signed

2.Place rectangles on signature positions

3.Rectangles must have following text to be recognized by our signing component signature_field_start:{json}:signature_field_end

4.The text can be small or even with same color as the rectangle to make it invisible for end user.

Useful hints

  • Rectangles can have any additional Word attributes (floating/fixed).
  • Signatures can locked using default Word section locking mechanism. Locked document is not possible to edit using Word Online. View is still possible.
  • Signature is considered every rectangle with the leading text signature_field_start:{json}:signature_field_end.Every rectangle will be found, parsed a replaced by our signature component inside Circularo.
  • Leading text can be as small as Word you allows and using same color as rectangle to make the text invisible for end user.
  • Word online cannot edit the text inside the rectangle → end users cannot broke prepared word documents. However, it is possible to delete whole rectangles.
  • Check the converted PDF between publishing any template. The converted PDFs can be slightly different (formatting, etc.) especially if converting in Circularo (It is converting using Open Source alternative LibreOffice).

Leading text must be visible inside the rectangle otherwise it will be removed during conversion.

Any other text inside the rectangle other than leading text will remain in the document after rectangle removal!

Spaces in values are normally preserved, but there is problem in case of the space is at the end of the line. These spaces are unfortunately removed during conversion. Try to avoid to have the wanted space at the end of the line or use non-breakable spaces or you can explicitly add space using character sequence \s.

Leading text JSON options

  • id - (string) Identifier of sign field (doesn’t have to be unique). If ID is provided, then its used, otherwise random unique ID is generated. It can be used only using workflow.
  • user - (string) User which has this sign field assigned to

Always use same combination of userRoleNameuserRoleId/user. They are specifying same person → Must be same in all fields.

  • position - (Object) Position is containing position itself (top left corner) and dimensions, both are expressed as a ratio within document page ⇒ all numbers are between 0 and 1
    • percentX - (float) X coord of top left corner <0, 1)
    • percentY - (float) Y coord of top left corner <0, 1)
    • percentWidth - (float) Width of field (0, 1>
    • percentHeight - (float) Height of field (0, 1>

Position will be filled automatically based on rectangle position. Will be ignored if present in JSON.

  • type - (string) Type of sign field [signatureinitialsstampwacomannotationimage]
  • timestamp - (boolean) Should timestamp be embedded into final signature? (not supported for annotation and image, default false)
  • text - (string) Text of annotation (annotation only), for annotation_dropdown it sets the default value selected in the dropdown list. The value must match one of the value of values.

If you want to make new line use following character sequence \n.

  • align - (string) Text alignment of annotation [leftcenterright] (annotation only, default left)
  • fontSize - (float) Font size of annotation (annotation only, default 11)
  • bold - (boolean) Use bold font (annotation only, default false)
  • color - (string) Color that text should use in hex format e.g. #7E544B (annotation only, default #000000)
  • page - (integer or Array<integer>) Page(s) on which this sign field should be located (first page is 1)

Page will be filled automatically based on rectangle position. Will be ignored if present in JSON.

  • order - (integer) Order in which this sign field should be signed (always signing from lowest non signed field) It can be used only using workflow.
  • subtype - (string) Further specification of sign field type (used only for docId for now) [ annotation_generic, annotation_date, annotation_full_name, annotation_company, annotation_phone, annotation_mail, annotation_role, annotation_check, annotation_dropdown ]
  • required - (boolean) Sign field must be filled for sign to complete (default false).
  • tooltip - (string) Tooltip displayed to user.
  • usage - (string) How this field should be filled [manualautomatic] (default manual) Only relevant for workflow (autosign feature).
  • values - (Array<string>) Array of possible values for annotation (annotation > annotation-dropdown only)
  • shareId - (string) Share ID which this sign field is bounded to.

ShareId will be filled by backend while sharing. Sign fields used during workflow have this value empty. Will be ignored if present in JSON.

  • backgroundColor - (string) Background color in hex format e.g. #7E544B (annotation only)

Not supported on FE at this moment

  • link - (string) If this value is set, then whole annotation will become link to provided URL (annotation only)

Not supported on FE at this moment

  • numberOfLines - (integer) How many lines annotation has. (annotation only, default auto)
  • font - (string) Name of font to use for annotation (annotation only)

Not supported on FE at this moment

  • userRoleId - (integer) Identifier of signer, used only in sign templates and signature extraction for first assignment to “real” users or shares.

Always use same combination of userRoleNameuserRoleId/user. They are specifying same person → Must be same in all fields.

  • userRoleName - (string) Only serves as display name for userRoleId

Always use same combination of userRoleNameuserRoleId/user. They are specifying same person → Must be same in all fields.

Required attributes

Components without required fields will be ignored!

Signatures fields (signature, initials, stamp, wacom)

  • position (automatically filled)
  • type
  • page (automatically filled)
  • userRoleId or user or both
  • userRoleName (recommended otherwise will be automatically generated)

Annotation fields

  • position (automatically filled)
  • type
  • page (automatically filled)
  • userRoleId or user or both
  • userRoleName (recommended otherwise will be automatically generated)

Examples of different rectangle placeholders

Sample of signature placeholder

signature_field_start:{"type":"signature","userRoleId":2,"userRoleName":"signer-2"}:signature_field_end

Sample of signature assigned to specific user

signature_field_start:{"type":"signature","user":"adam.smith@circularo.com","userRoleId":1,"userRoleName":"signer-1"}:signature_field_end

Sample of generic text placeholder

signature_field_start:{"type":"annotation","subtype":"annotation_generic","userRoleId":1,"userRoleName":"signer-1","align":"left","fontSize":12}:signature_field_end

Sample of date placeholder

signature_field_start:{"type":"annotation","subtype":"annotation_date","tooltip":"Select date…","userRoleId":1,"userRoleName":"signer-1"}:signature_field_end

Sample of dropdown placeholder

signature_field_start:{"type":"annotation","subtype":"annotation_dropdown","id":"annotation-1","userRoleId":1,"userRoleName":"signer-1","align":"left","fontSize":12,"values":["test-1","test-2"],"text":"test-2"}:signature_field_end

Example documents

Word-template-example.docx @ Google Drive