Professional Documents
Culture Documents
Guide
Exari Contracts
Authoring for Exari Contracts Guide
Document Reference: Authoring for Exari Contracts
Date: 25-Jul-17
Authoring for Exari Contracts
1 Table of Contents
2 Revision History & Approvals ............................................................................................................................................. 3
2.1 Document Revision History ....................................................................................................................................... 3
3 Executive Summary ............................................................................................................................................................ 4
3.1 Purpose of Document ................................................................................................................................................ 4
3.2 Proposed Audience .................................................................................................................................................... 4
4 Exari Contracts Overview ................................................................................................................................................... 5
4.1 The Exari Contracts Platform ..................................................................................................................................... 5
4.2 The Universal Contract Model ................................................................................................................................... 5
4.2.1 The UCM Object Model ......................................................................................................................................... 5
4.2.2 The UCM Data Dictionary ...................................................................................................................................... 6
5 Authoring Principles ........................................................................................................................................................... 9
5.1 Data passed into the Exari DocGen template .......................................................................................................... 9
5.2 Data passed back to Exari Contracts ...................................................................................................................... 11
5.3 The importance of Relations .................................................................................................................................... 13
5.4 Final Data Capture ................................................................................................................................................... 15
5.5 Reporting data ......................................................................................................................................................... 17
5.6 Workflow triggers .................................................................................................................................................... 17
5.7 Mandatory requirements ........................................................................................................................................ 18
5.8 Summary of Principles ............................................................................................................................................. 22
6 Authoring in Practice ........................................................................................................................................................ 23
6.1 Step by step guide ................................................................................................................................................... 23
6.1.1 Template Logic .................................................................................................................................................... 23
6.1.2 Order Transactions .............................................................................................................................................. 25
6.1.3 Data Capture Summary ....................................................................................................................................... 26
6.1.4 Template Group Logic ......................................................................................................................................... 27
7 General Authoring Notes .................................................................................................................................................. 31
7.1 Publishing Templates to Exari Contracts ................................................................................................................. 31
7.2 Guidance Notes / Tips .............................................................................................................................................. 34
8 Appendix ........................................................................................................................................................................... 35
8.1 Definitions ................................................................................................................................................................ 35
Authoring for Exari Contracts
1.1
1.2
Authoring for Exari Contracts
3 Executive Summary
3.1 Purpose of Document
This document describes how Exari DocGen smart templates need to be authored for the Exari Contracts platform. It acts
as a guide for implementation and should be used in conjunction with existing authoring resources available on the Exari
Knowledge Base.
Authoring for Exari Contracts
The Object Model defines the various objects that make up a contract. These include the parties (Legal Entities /
Organizations), the Contracts themselves, the various Transactions within those contracts (the original contract, an
Assignment, an Amendment etc.) and the documents within those Transactions (the Agreement and Schedule, a Deed of
Assignment, a Change Order etc.). The following diagram illustrates the possible relationships between these various
objects -
Image: Universal Contract Model - Objects
Authoring for Exari Contracts
Not all contracts will require all objects but it is important to know that Exaris UCM will have the breadth to support all of
these different contractual scenarios. Understanding how these objects relate to each other is imperative before
attempting to capture / understand the data within each.
The second part of the UCM is the Data Dictionary. This delivers a comprehensive view of all contractual rights, risks,
obligations and performance provisions within each Transaction. This Dictionary is extendable and can be configured to
meet the individual customer needs. Similar properties can be grouped together for easier visualisation, search and
reporting (i.e. Contract Details or Relationship Management). The Data Dictionary is maintained centrally in the Exari
Contracts platform but each property can be collected during the interview driven creation process. As questions are
answered, the data is mapped to the relevant property(s) in the Data Dictionary.
Image: Universal Contract Model Data Dictionary
Seeing a contract in Exari Contracts brings the UCM to life. As an example, the screenshot below shows a contract record
with two Legal Entities, many Transactions (the various items in the tree diagram on the left) and the various documents
inside those Transactions (the Documents pane on the right). The Actions bar in the centre offers the user the ability to
create new transactions as and when required (i.e. Create Order, Terminate or Rescind). These actions can launch
different smart templates as and when required -
Authoring for Exari Contracts
Image: Options available to the user at the deal level
The data for each Transaction is summarised via the Properties pane in the centre of the screen. Clicking Show More
Properties will pop-up all of the core Data Dictionary properties captured for the Transaction in question
Image: Properties from the contract interview populating the Data Dictionary visible in the Contracts UI
Note that once a Transaction moves from a Draft status to an Active status, its data can roll up into the Master. Clicking
the top-level properties then, will show an accurate picture of the contract as a whole at that point in time.
From here it is then possible to search or filter across your contract portfolio via these specific properties
Authoring for Exari Contracts
Image: Contracts Search
Image: Reports dashlet on the User Dashboard
In summary, the modelling of contract objects combined with a robust Data Dictionary enables unparalleled visibility into a
contract portfolio.
Authoring for Exari Contracts
5 Authoring Principles
In order for smart templates to run in Exari Contracts, the author needs to ensure that the appropriate logic is in place such
that the correct templates are launched at the correct points in the process (i.e. when the user clicks Create Amendment,
they want the Amendment template to fire as part of an Amendment Transaction) and that the appropriate data is
collected from those templates to populate the UCM Data Dictionary. This section of the guide will describe some of the
key principles / mandatory requirements for authoring.
Authoring for Exari Contracts
Authoring for Exari Contracts
GroupMembership The Exari Contracts Will be in the form of a comma separated list. As an - Can be used to
User Groups that example determine which logic
the user running the Legal_Approvers,Super_Users,Commercial_Approvers fires in a Template (i.e.
interview belongs to User Group
Legal_Approvers are
asked question 1 whilst
Commercial_Approvers
are asked question 2)
Example External Query which allows the template to consume Contracts data:
Image: SiteID External Query created in Power Author
Authoring for Exari Contracts
circa 250 properties in the out of the box Data Dictionary. As part of a project / implementation, it may be that the model is
extended to include customer specific property groups and properties
Authoring for Exari Contracts
Image: How to add a relation to any variable
This is how we determine if the logic item needs to be part of the UCM Data Dictionary. We add a Relation and then choose
the AlfrescoMetadata relation type from the Field dropdown
Image: Applying a Contracts relation
Then we type in the Property Name in the FieldValue (the name as per the Exari master UCM Data Dictionary it must be
a character by character match with no spaces)
Image: Mapping the relation to a specific field in the Data Dictionary
Authoring for Exari Contracts
Saving this change will ensure that when the question is answered in the interview, the answer will make its way into Exari
Contracts
Image: Interview question where Contracts relation has been applied
Image: Answer provided in interview displaying within the Contracts Data Dictionary
There are a number of other Relation types available (these will be covered in more detail later in this document). For
reference, these are
Relation Field Description
alwayssave Saves the answer to the Answer Manager (typically applied to logic types that are not
saved by default External Queries / Database Queries etc.)
dontsave Intentionally omits the answer from the Answer Manager (typically applied to logic
types that are saved by default User Text Questions etc.)
dontload Ensures the saved answer isn't loaded on a return to interview (typically applied
when wanting to reinitiate a look up from an external source)
Authoring for Exari Contracts
AlfrescoMetadata Maps the variable answer to the relevant property in the UCM Data Dictionary
copysafe-OrderContainer Will ensure that the value from the Master is kept for use in the Order
copyto-OrderContainer Will map the variable's answer to a new Order- specific variable named in the
corresponding FieldValue (e.g. "MasterTitleLookup")
resetcopy-CreateOrder Will use the Master's answer as a default in the Create Order transaction (forcing the
question to be re-evaluated in the Order interview)
contracts-OrderAggregate-Sum = ContractValueCommitted: This is to ensure that the value of the Order rolls up to
the total committed value at the contract level
contracts-TransactionOnly Flags that the variable is specific to the Transaction (i.e. DateEffectiveTransaction)
and not the master
Image: Edit Status selected by user to change status to Final Pending QA
Authoring for Exari Contracts
Image: Final Capture action available at transaction level
Final Capture forces the end user to check that the data they have collected to date is accurate (the answers they
gave during the initial drafting / creation interview may no longer be relevant / up to date as the document has
likely been negotiated off platform)
Final Capture provides an opportunity to ask any additional questions that were not relevant / known at the time
of initial drafting but are useful pieces of data to commit now (an example might be Total Number of Legal Hours
spent on this contract this would only be known at the point of execution)
Final Capture clears out stale data from the Answer Manager so that the answers committed to Exari Contracts
(and the reporting database) are clean. In other words, only the questions that are validated at Final Capture can
make their way into the reporting database (DB) and only questions validated at Final Capture can be re-used in
downstream Transactions (or indeed in a clone of one contract to another). An example could be that there was a
multiple-choice question What is your Favourite Colour? with four possible options Red, Blue, Green or Other.
When first drafting, the user selected Other and a follow-on User Text Question allowed them to type in Purple.
At this point, the Answer Manager holds two answers one for the MCQ (Other) and one for the UTQ (Purple).
Perhaps the user then returns to interview and changes their answer from Other to Blue. At this point, the
Answer Manager still holds two answers one for the MCQ (Blue) and one for the UTQ (Purple). Just because
Purple is no longer relevant, doesnt mean its not persisting in the Answer Manager. Final Capture ensures that
the UTQ (and its answer Purple) are cleared out of the latest version of the answers as the data is stale and not
an accurate reflection of the most up to date data for this particular contract.
Final Capture typically uses a separate template which outputs a term sheet or high level 1 2 page summary of
the key Contractual Terms. This is a great way for end users to quickly review / understand the main points about a
Contract / Transaction without having to read the entire Contract in full
A consideration then, is that a contract being generated via Exari Contracts should be a template group with a minimum of
two templates
The drafting template (i.e. the Non Disclosure Agreement / Master Services Agreement / Consultancy Agreement
etc.)
A dedicated Capture Template (to validate that data in the drafting template / output a summary of terms)
Authoring for Exari Contracts
Image: Drafting template output Image: Capture template output
Image: Contract Summary template for Contracts in the DocGen Repository
Variable Description
WorkflowApproach Options are RiskRating or ApproverGroup controls the type of workflow being triggered
CompletionStatus Options are Draft or Final determines when the workflow is triggered (only when set to
Final)
ApprovalsRequired If the WorkflowApproach is ApproverGroup, this variable allows the user to specify which
group(s) to be notified via a comma separated list
Authoring for Exari Contracts
Authoring for Exari Contracts
These can be found in the Contract UI here
Image: Contract Naming Convention
Note that the Effective MONTH DAY, YEAR text is dynamic if no Effective Date is passed from the template, this text will
not display in the UI.
Authoring for Exari Contracts
This can be found in the Contract UI here
Image: Contract Title displayed in Exari Contracts
Authoring for Exari Contracts
6. Renew
7. Assign
8. Novate
ContractStructure ContractStructure is passed automatically into the
template from Exari Contracts. This identifies the
Relation: alwayssave
Contract Type
Relation: dontload
1. Master
2. Standalone
3. Order
Conditions for template TransactionType.CreateContractAND Condition to be applied when launching the initial
firing: Contract (example) transaction / contract
ContractAction.Generate
These would be applied to
TransactionType.CreateContractAND Condition to be applied when launching the capture
the individual templates in a
Template Group template for the initial transaction / contract
ContractAction.Capture
TransactionType.CreateContractAND Condition to be applied when launching a correction
template for the initial transaction / contract
ContractAction.Correction
Conditions for template TransactionType.AmendAND Condition to be applied when launching the Amendment
firing: Amendment transaction / template
ContractAction.Generate
(example)
These would be applied to TransactionType.AmendAND Condition to be applied when launching the capture
the individual templates in a template for the Amendment transaction
ContractAction.Capture
Template Group
TransactionType.AmendAND Condition to be applied when launching a correction
template for the Amendment transaction
ContractAction.Correction
Exari can provide an example template (Contracts Authoring.xml) that includes all of the above mandatory logic items by
default. This template features an invisible ParagraphGroup which can be copied into any template. A combination of this
and merging logic from the Contract-Summary-CM.xml template will give you everything you need for the template to be
Contracts enabled. Alternatively, the Master Services Group (also shipping with the Exari Contracts installation)
showcases multiple templates in a group and how to control each of these so that they launch at the relevant points in the
process.
Authoring for Exari Contracts
Summary Template (the data capture template at Final Capture - for both the initial contract and the amendment))
An optional Correction Template (typically the Correction' action would re-execute the Summary template but
know that it is possible to use a separate template here - a common use case will be allowing end users to make a
correction but restricting which data they can change)
Image: Example Template Group Structure
Authoring for Exari Contracts
6 Authoring in Practice
6.1 Step by step guide
6.1.1 Template Logic
(a) Import the Contracts Authoring.zip into the Exari DocGen Repository (the zip should be included with
this guide). Note that the zip includes a stand alone template (Contracts Authoring.xml) and a Smart
Module version of the same template (Contracts Authoring.sm)
Image: Template Import
Image: Template Import Upload
(b) Import the smart module into the template(s) that will be launched from Exari Contracts (referring the
module would be the best approach as it ensures the module is maintained centrally / separately to the
templates)
Image: External Import Smart Module
Authoring for Exari Contracts
Image: External Import Smart Module Popup
Image: Select Contracts Authoring.sm
(c) If importing the smart module and using a single logic file across the template suite then synchronise the
logic
(d) Note that the template contains all mandatory logic required by Exari Contracts including examples of
the conditions that can be applied to templates in a group (to control which templates are launched at
which points in the process). The ParagraphGroup is flagged as hidden meaning it wont show in the
output document but will execute the relevant logic. Enabling test mode or disabling the hidden
parameter will expose the ParagraphGroup in the output document (useful for diagnosing any template
issues)
Image: Exari Contracts Authoring
Authoring for Exari Contracts
(e) It may be that some of the variables in the ParagraphGroup already exist with alternative names / topics
in your template be sure to replace your existing variables with those defined in the new
ParagraphGroup. The variable names / topics / questions etc. can change. The important thing to note is
that the relations set on the variables should not change. Beware situations where your template
already contains variables with matching names. In this scenario, the existing logic will trump that of
the template / smart module and some cross checking / manual updating will be required
(f) Determine if any of the pre-existing template logic should be mapped to the UCM Data Dictionary (the
business / document analyst should have provided this to the author as part of the requirements
gathering phase)
(g) Apply the relevant AlfrescoMetadata relations to those variables that should be mapped to the Data
Dictionary. A tip here is to consider merging in logic from the Contract-Summary-CM.lgc file as this
holds all of the out of the box Exari Data Dictionary properties by default
(a) If using downstream Order templates, be sure to apply the following relations where applicable to your
master template variables
(i) copysafe-OrderContainer will ensure that the value from the Master is kept for use in the Order
this can be used in conjunction with:
1. resetcopy-CreateOrder which will use the Master's answer as a default in the Create Order
transaction
2. copyto-OrderContainer which will map the variable's answer to a new Order-specific
variable named in the corresponding FieldValue (e.g. "MasterTitleLookup")
(b) if you don't have Copysafe-OrderContainer on anything, then every value will be kept for use in the
Order
(c) When you create an Order, the system will first create an Order Container behind the scenes where the
copying in step (a) above happens
(d) immediately following, the Create Order transaction will be created based on the Order Container's
answers
(e) Orders can't have a different currency from the Master, so you need to use MasterValueCurrencyLookup
in your Orders to insert the Master currency
(f) The Order value variable (e.g. "OrderValueTotal") needs to have the Relations:
(i) AlfrescoMetadata = OrderValueTotal
(ii) contracts-OrderAggregate-Sum = ContractValueCommitted (this is to ensure that the value of the
Order rolls up to the total committed value at the contract level)
(iii) alwayssave = true
(iv) dontload = true
(g) You can reference the parent master agreement in your Order by copying the following from the
Contract Summary template: "Made under MasterTitleLookup dated MasterDateEffectiveLookup
between MasterPartiesLookup"
(h) In the Contracts Template Bank, make sure you set the properties for your Order template to:
Authoring for Exari Contracts
(a) With the Summary template, you can copy from the Contract-Summary-CM.xml template then:
(b) one approach is to always adopt only one of the 3 Basic / Intermediate / Detailed responses (usually
Intermediate):
(i) delete structures that have the unwanted Capture.* conditions on them
(ii) remove the remaining Capture.* conditions from use in the template so you don't get asked the
Type of Capture question
(c) another approach might be to hardcode responses for specific TransactionType scenarios.
(d) If the data dictionary has been customised, then it may be that the Data Capture template is built from
scratch
(e) You will need to determine if a separate Data Capture template is required for each template type or
whether a single generic capture template can sit across the entire document suite (all template types).
Note that if a variable is unique to a particular drafting template (i.e. an NDA) and it is not validated as
part of the Data Capture process, it will not be available for use in downstream transactions or cloned
deals
Authoring for Exari Contracts
(a) The Template Group should hold all templates relevant to the Exari Contracts process. As a minimum this
would typically be the Contract Drafting template and the Data Capture template. In a more
sophisticated example, this could include separate Amendment / Termination / Novate etc. templates
(b) Once the resources have been added to the group, the relevant combination of ContractAction and
TransactionType conditions should be built and applied to the relevant resources. This will ensure the
appropriate templates fire at the appropriate points in the process.
Example Goal:
Get an Amendment Letter template to fire on an Active contract (i.e. clicking the Create Amendment action should
trigger the Amendment interview)
Example Authoring Solution:
Image: Group Add Resource
Image: ContractAction variable
Authoring for Exari Contracts
Image: TransactionType variable
Image: ContractAction.Generate condition
Authoring for Exari Contracts
Image: TransactionType.Amend condition
Image: TransactionType.Amend condition
Authoring for Exari Contracts
Image: Group Resources and Conditions
From a Contracts perspective, we would manually launch the Amend action at the deal level (this action is in the default
configuration and is only available once the contract is Active). This would pass the 'TransactionType.Amend into the Group
and launch the Amendment Letter template
Image: Create Amendment via Exari Contracts
Authoring for Exari Contracts
Image: Exari Contracts Ribbon
The Repository folder view will open. Expand the Template Bank folder in the Repository folder view
Image: Template Bank folder in Repository view
Authoring for Exari Contracts
By default, all newly published templates will be available in the New Templates folder
Image: New Templates Folder
Templates in the New Templates folder can only be launched from the Template Bank by an Administrator. If the user
wishes to expose the template to end users, they need to move the template to an alternative folder location (the product
ships with a folder called Published Templates by default but you do not have to use this. Before moving the template, the
user should configure the Template by clicking Edit Properties against the relevant template record
Image: Edit Template Properties
Image: Template Properties Popup
Authoring for Exari Contracts
Field Description
Name Display name for the template in the Template Bank
Title Title as exposed in the My Contracts dashlet Smart Template dropdown
Template Use Description of the template (pre-populated from DocGen). Will display in a
hover note in the Template Bank
Allow Create Interview? Determines if it is possible to launch a Creation (drafting) template at the start
of the process
Allow Data Capture? Determines if it is possible to launch a Data Capture template at the start of
the process
Allow Create Amendment Interview? Determines if it is possible to create an Amendment as part of the Contracts
lifecycle
Output Document Format DOCX / PDF / RTF dropdown
Interview Type Contract / Order dropdown (setting as Order will treat the template as an
Order of a Master and will force the user to associate the Order to a pre-
existing deal before launching the interview)
Master Agreement Flag as to whether or not the template is a standalone agreement or a Master
(which can then support downstream transactions such as Orders)
Order Template Allows the user to choose a template (or group) from the Template Bank which
will be the dedicated Order Template for this Template type. This template will
be called when clicking the Create Order action in a Contract
Output Container The Contract Naming Convention for this Contract (Container Bank is covered
by Admin Training)
Template Status Current / Archived (Archived will hide from view for all users)
Set the relevant configuration options as required and then move the template to the appropriate folder in the Template
Bank to complete this setup
Image: Move To Template Bank
Authoring for Exari Contracts
Group
o Standalone Agreement template
o Summary template
Full-blown:
Group
o Master Agreement template
o Standalone Agreement template
o Summary template
o Order template
o Amend template
o Renew template
o Assign template
o Novate template
o Terminate template
o Rescind template
Certain logic items must always be included in the template for downstream Contracts functionality (e.g.
reporting)
Use the Logic Export to Excel as a way of quickly visualising all of the Relations
Ensure Relations are not duplicated (unless there is a valid use case to do so)
A small number of properties in the Data Dictionary can be multi valued (i.e. Counterparty Name)
Authoring for Exari Contracts
8 Appendix
8.1 Definitions
Name Definition
CLM Contract Lifecycle Management
Exari Contracts The end to end Contract Lifecycle Management solution from Exari
Exari DocGen The Document Generation component of the Exari solution
UCM Universal Contract Model
Object Model The objects that make up Exaris Universal Contract Model
Data Dictionary The properties that make up Exaris Universal Contract Model
TransactionType A Transactional object that forms part of the Object Model
Relations DocGen tags which give template logic items special attributes for the Data Dictionary and
Object Model