Macros
- 1 What are macros
- 1.1 Contract Signatures macros
- 1.1.1 The signature macro
- 1.1.1.1 Types
- 1.1.2 The signer macro
- 1.1.2.1 Types
- 1.1.3 The contract metadata macro
- 1.1.3.1 Types
- 1.1.4 The contract signatures details macro
- 1.1.5 The contract signatures visibility control macro
- 1.1.5.1 Types
- 1.1.1 The signature macro
- 1.1 Contract Signatures macros
What are macros
Macros enable users to extend capabilities by following a patter or sequence of events, Contract Signatures utilizes macros to enhance functionalities and improve user experience!
You can read more about macros here!
Contract Signatures macros
There currently 5 Macros developed for Contract Signatures:
The signature macro
The signer macro
The contract metadata macro
The contract signatures details macro
The contract signatures visibility control macro
Each of the above mentioned macros will grant specific functional capabilities to the user.
The signature macro
This macro will create functional block, user can then place it anywhere on the document page, by default, the value of this block is set to Signature.
This functional block, will be assigned to a Person(x) and will require that person to take action on this field when the contract is read. In simpler terms, this is where you create a signature field designate it to a signer.
The block consists of two crucial information:
Type
Person
and two additional information
Full name
Email address
Additional information such as Full name and email address may be provided, this additional fields are specially useful for dynamically filling the required fields in contract creation and can save time.
Types
Following types are available to choose from:
Signature - Will require a signature from the designated person.
Date - Will allow the designated person to select a date.
Initials - Will require initials from the designated person.
Text - Will enable the designated person to leave a comment, add text.
Checkbox - Will allow the designated person to check the checkbox.
Checkbox has three stages, it will be empty when the contract is started, however it can be turned On (selected) or Off (remained empty).
The signer macro
This macro will dynamically display signer data once the contract is created and this field cannot be filled or altered by signers.
There are only two crucial information required for this field:
Type
Person
Types
Following types are available to choose from:
Legal name - Will display signer’s full legal name
Email address - Will display signer’s email address
Phone number - Will display signer’s phone number
Signing date - Will display signer’s signing date
Signing date and time - Will display signer’s signing date and time
The contract metadata macro
Similar to the signer macro, a set of information will be displayed on created contract, this information cannot be filled or altered.
There is only 1 crucial information required to enable this macro:
Type
Types
Depending on the type, the value will be displayed once the contact is created.
contract identifier
contract name
contract certificate URL
creation date
creation date and time
completion date
completion date and time
expiration date
time zone
creator name
creator identifier
creator IP address
contract recipient name and email list
contract recipient name list
contract recipient email list
watcher name list
watcher email list
Confluence URL
Confluence page URL
Confluence page identifier
Confluence page title
Confluence space identifier
The contract signatures details macro
This macro is specially useful if there are multiple contacts created on the same document, this macro is not visible on the contract, instead it will provide a panel to the admin for an enhanced overview and enables quick access to all the contracts created on the designated page.
There are no required fields for this macro, however user can change the size of the macro in the configuration.
The contract signatures visibility control macro
This macro will allow user to quickly hide part of the document in the contract. This is specially useful is user wishes to keep the document without deleting any of the content but create a contract from deducted version of the document.
In order to use this macro, a type is required:
Types
Start - Placed before right before the content that needs to be deducted.
End - Place right after the content that needs to be deducted.
If only the type “Start” is used without an “End” type, then any content after the start will be deducted.
If used inside a table, it will only delete the content inside the designated cell.