TUTORIAL NOT APPLICABLE TO ESPO V6 AND AFTER
This tutorial describes the steps necessary to incorporate the electronic signature capability using the esignature extension.
For this tutorial we will use a custom entity named "Work Order".
1) After downloading and installing the extension go to:
Administration > Entity Manager > Work Order > Fields > Add Field > eSignature
enter the field name ("tenantSignature") and the label ("Tenant Signature").
2) Go to Administration > Layout Manager > Work Order > Detail
Add the "Tenant Signature" field as a single column item at the bottom of the layout like this:
3) After completing the above steps, the Work Order detail display will look like this:
4) If you wish to grant access to portal users to see and edit work orders linked to their lease contracts, they can access the detail view directly in their computers or phones and sign using a mouse or finger with touch screens in the traditional espo layout. After signing they must click on the "Update" link to save the signature.
The esignature will not be editable once it's saved to satisfy legal requirements, which require that esignatures can not be altered, but prior to saving an esignature, a user can make changes by clicking on a "Undo Last Stroke" link that appears below the signature canvass.
5) The extension also allows you to create a custom template to display the the Work Order in full screen view, incorporating images or any custom css, which can be printed to PDF using your browser's pdf rendering engine.
For example, in our application, we also use esignature for lease contracts that require our signature, which is saved and attached as a regular image in the custom template.
6) To accomplish the above for the Work Order entity, it is necessary first to modify the Work Order clientDefs settings file to let Espo know that the extension's custom record detail view must be used to render the Work Order in detail display:
custom/Espo/Custom/Resources/metadata/clientDefs/WorkOrder.json
7) Nest step is to create a custom template and include a special placeholder @sig[{{field-name}}]/sig@@ for the esignature field as shown below.
Note that in our example, the esignature field name is "tenantSignature", so the actual placeholder is: @@sig[tenantSignature]/sig@@:
8) Once a template has been created for "Work Order", the extension will remove the "Print PDF" option from the top left "Edit" menu dropdown and will include instead a new option to print the eSignature document in full screen view and include two action buttons at the top of the document: One to print to PDF using the browser's engine and another one to close the document.
This tutorial describes the steps necessary to incorporate the electronic signature capability using the esignature extension.
For this tutorial we will use a custom entity named "Work Order".
1) After downloading and installing the extension go to:
Administration > Entity Manager > Work Order > Fields > Add Field > eSignature
enter the field name ("tenantSignature") and the label ("Tenant Signature").
2) Go to Administration > Layout Manager > Work Order > Detail
Add the "Tenant Signature" field as a single column item at the bottom of the layout like this:
3) After completing the above steps, the Work Order detail display will look like this:
4) If you wish to grant access to portal users to see and edit work orders linked to their lease contracts, they can access the detail view directly in their computers or phones and sign using a mouse or finger with touch screens in the traditional espo layout. After signing they must click on the "Update" link to save the signature.
The esignature will not be editable once it's saved to satisfy legal requirements, which require that esignatures can not be altered, but prior to saving an esignature, a user can make changes by clicking on a "Undo Last Stroke" link that appears below the signature canvass.
5) The extension also allows you to create a custom template to display the the Work Order in full screen view, incorporating images or any custom css, which can be printed to PDF using your browser's pdf rendering engine.
For example, in our application, we also use esignature for lease contracts that require our signature, which is saved and attached as a regular image in the custom template.
6) To accomplish the above for the Work Order entity, it is necessary first to modify the Work Order clientDefs settings file to let Espo know that the extension's custom record detail view must be used to render the Work Order in detail display:
custom/Espo/Custom/Resources/metadata/clientDefs/WorkOrder.json
Code:
"recordViews": { "detail": "esignature:views/record/detail" }
Note that in our example, the esignature field name is "tenantSignature", so the actual placeholder is: @@sig[tenantSignature]/sig@@:
8) Once a template has been created for "Work Order", the extension will remove the "Print PDF" option from the top left "Edit" menu dropdown and will include instead a new option to print the eSignature document in full screen view and include two action buttons at the top of the document: One to print to PDF using the browser's engine and another one to close the document.
Comment