SPECIAL VARIABLES AND FUNCTIONS

 

 

INTRODUCTION

 

In LegalSuite, you can use Merge Fields and Party Fields to insert data from the SQL database into documents.

 

e.g. [[(MAT:ClaimAmount)]] will insert the Matter’s Claim Amount into the Document

 

There are other variables that may not be stored in the SQL database that you might want to use in a Document or in a Conditional statement. These are what we call “Special Variables”. They may either be static variables or functions.

 

Static Variables:

 

If you wanted your name to appear in a Document, for example, you cannot put [[(EMP:Name)]] in the Document because this just tells the program to put whatever name it happens to have last accessed into the Document. It may (by coincidence) be your name, but if just before assembling the Document, the program looked up the Employee who the Matter belongs to, it may have this name in memory and insert that name instead of yours. So this can cause inconsistent results.

 

To resolve this, we store certain information in static variables, i.e. variables whose contents do not change. LegalSuite stores the name of the user who logged into LegalSuite in a variable called GLO:UserName. So if you used [[(GLO:UserName)]] in the Document you would be assured of getting the correct name displayed every time.

 

Functions:

 

Sometimes we need to extract more than a simple variable or we may need to test for a certain condition.

 

For example, you may want to only include a certain paragraph in a Document if there is more than one Defendant. This is where a function comes in. There is a function in LegalSuite called “CountParties”. If you examine the function listed below, you will notice it takes 1 parameter – the Role of the Party you want to count.

 

e.g. CountParties(‘Defendant’)  would return 1 if there was one Defendant, 2 if there were two etc.

 

You could then use it in a Document like this:

 

[[IF(CountParties(‘Defendant’)>1)]]All of you must be in court at the same time[[ENDIF]]

 

 

Document Fields vs Conditional Statements

 

The examples given below illustrate how you would use these variables and functions in a Document. All these variables and functions can also be used as Conditional Statements. You just drop the double square brackets.

 

For example, if you only wanted an Extra Screen to be available if there are multiple Defendants in a Matter, you could insert “CountParties(‘Defendant’)>1” as the condition. See Figure 1.

 

 

Figure1: Using a Function as a Conditional Statement

 

 

VARIABLES

 

Variable

Description

Example

GLO:SupervisorFlag

Returns 1 or 0
1 indicates the Employee has Supervisory Rights

[[IF(GLO:SupervisorFlag=1)]]

You have supervisor rights

[[ELSE]]

You do not have supervisor rights

[[ENDIF]]

GLO:SecGroupID

Returns the RecordID of the Security Group the Employee belongs to

[[IF(GLO:SecGroupID <>5)]]

You cannot do that

[[ENDIF]]

GLO:EmployeeID

Returns the RecordID of the logged in Employee

[[IF(GLO:EmployeeID =5)]]

Hello User No 5

[[ENDIF]]

GLO:DocumentLanguageID

The Document Language of the Matter

[[IF(GLO:DocumentLanguageID =2)]]

Geagte Meneer

[[ELSE]]

Dear Sir

[[ENDIF]]

GLO:TodaysDate

Returns the date entered by the Employee when they logged into LegalSuite

Today’s Date is [[(FORMAT(GLO:TodaysDate,@D17))]]
will give the following:

Today’s Date is 14/4/2010

Note: See the White Paper on Formatting Dates

GLO:NoOfPlaintiffs

Returns the number of Plaintiffs linked to the current Matter

[[IF(GLO:NoOfPlaintiffs=1)]]

The Plaintiff was duly represented

[[ELSIF(GLO:NoOfPlaintiffs>1)]]

The Plaintiffs were duly represented

[[ENDIF]]

GLO:NoOfDefendants

Returns the number of Defendants linked to the current Matter

[[IF(GLO:NoOfDefendants=1)]]

The Defendant was liable

[[ELSIF(GLO:NoOfDefendants>1)]]

The Defendants were jointly and severally liable

[[ENDIF]]

GLO:DeliveryCode

Returns the Delivery Code selected when merging the document (setup on the document)

[[IF(GLO:DeliveryCode=’FAX’)]]BY FAX: [[Selected.Party.Telephone.Fax]][[ENDIF]]

[[IF(GLO:DeliveryCode=’REGIST’)]]REGISTERED MAIL[[ENDIF]][[IF(GLO:DeliveryCode=’HAND’)]]BY HAND[[ENDIF]][[IF(GLO:DeliveryCode=’COLLECT’)]]TO BE COLLECTED[[ENDIF]]

GLO:UserName (UserName)

Returns the Name of the logged in Employee (retrieved from the Employee setup)

Please do not hesitate to contact me, [[(GLO:UserName)]] if you have any queries

GLO:LoginID (LoginID)

Returns the Login ID of the logged in Employee (retrieved from the Employee setup)

[[IF(GLO:LoginID = ‘JD’)]]

You are logged in as Jennifer Daly

[[ENDIF]]

GLO:Reference

Returns the personal reference of the logged in Employee (retrieved from the Employee setup)

Please quote the following reference in all correspondence: [[(GLO:Reference)]] =

Please quote the following reference in all correspondence: AAA/ZZZ/Jennifer

GLO:Email

Returns the email address of the logged in employee (retrieved from the Employee setup)

The writer’s direct email address is [[(GLO:Email)]] =

The writer’s direct email address is Jennifer@legalsuite.co.za

GLO:Fax

Returns the fax number of the logged in employee (retrieved from the Employee setup)

The writer’s direct fax number is [[(GLO:Fax)]] =

The writer’s direct fax number is 086 5101567

GLO:Telephone

Returns the telephone number of the logged in employee (retrieved from the Employee setup)

The writer can be contacted directly on [[(GLO:Telephone)]] = The writer can be contacted directly on 031 - 5711183

GLO:FormalName

Relates to Generic Bond Documents Only

 

Returns the Formal Name as contained in the Document Generator Database (F3) on a Generic Bonds Matter (General Tab)

The Formal Name of the Institution is [[(GLO:FormalName)]]

GLO:ShortName

Relates to Generic Bond Documents Only

 

Returns the Short Name as contained in the Document Generator Database (F3) on a Generic Bonds Matter (General Tab)

The Short Name of the institution is [[(GLO:ShortName)]]

GLO:RegistrationNumber

Relates to Generic Bond Documents Only

 

Returns the Registration Number as contained in the Document Generator Database (F3) on a Generic Bonds Matter (General Tab)

The Registration Number of the institution is [[(GLO:RegistrationNumber)]]

GLO:Division

Relates to Generic Bond Documents Only

 

Returns the Division as contained under Setup | Document Sets | Generic Bonds | English / Afrikaans

 

The Division is [[(GLO:Division)]]

GLO:FooterLocation  

Returns the location of the footer used at the bottom of Generic Bond Documents

INCLUDE([[(GLO:FooterLocation)]])

GLO:HeaderLocation   

Returns the location of the header used at the bottom of Generic Bond Documents

INCLUDE([[(GLO:HeaderLocation)]])

 MAT:TrustBankAccount

Returns the name of the trust account the Matter uses

[[(MAT:TrustBankAccount)]]

MAT:BusinessBankAccount   

Returns the name of the business account the Matter uses

[[(MAT:BusinessBankAccount)]]

MAT:Consolidated

Returns the File Ref of the Matter the current Matter is consolidated with

[[(MAT:Consolidated)]]

 

FUNCTIONS

 

Function

Description

Document Example

SQLScript

Runs a SQL script

 

This can be used in Extra Screens as a condition or in documents to return a result

[[IF(SQLScript(‘SELECT COUNT(1) FROM MatParty WHERE MatterID = [[(MAT:RecordID)]] AND RoleID = 2))’) > 0

There are some Defendants linked to this Matter

[[ENDIF]]

 

GetDayofWeek (GDOW)

Returns the day of the week

 

GetDayofWeek(‘Code’)

Or

GDOW(‘Code’)

 

 

 

A Letter of Demand was sent to the Debtor on [[(GetDayOfWeek(‘0000’))]], [[(FORMAT(GetStageDate(‘0000’),@D18))]] and Summons subsequently served on [[(GetDayOfWeek(‘0021’))]], [[(FORMAT(GetStageDate(‘0021’),@D18))]] =

A Letter of Demand was sent to the Debtor on Monday, 21 September 2009 and Summons subsequently served on Friday, 16 October 2009

 

GetStageDate (GSD)

Returns the date of a specific stage (from File Notes)

 

GetStageDate(‘Code’)

Or

GSD(‘Code’)

 

 

A Letter of Demand was sent to the Debtor on the [[(FORMAT(GetStageDate(‘0000’),@D18))]] and Summons subsequently served on the [[(FORMAT(GetStageDate(‘0021’),@D18))]] =

 

A Letter of Demand was sent to the Debtor on the 21 September 2009 and Summons subsequently served on the 16 October 2009

 

CheckStage (CS)

Returns 1 if the condition is true

 

CheckStage(‘Code’)

Or

CS(‘Code’)

[[IF(CheckStage(‘0020’)=1)]]Summons was served on the Defendant[[ELSIF(CheckStage(‘0020’)<>1)]]The Sheriff was unable to effect service of the Summons and we are proceeding to trace the Defendant[[ENDIF]]. =

Summons was served on the Defendant.

 

GetDocumentField (GDF)

Returns the contents of a specific field in a Desktop Extra Screen

 

Parameters (Description,FieldNo)

Where

Description = The Name (or RecordID) of the Extra Screen

FieldNo = The Field number (1-30) (fields 21 – 30 are calculation fields and are not displayed on the screen)

[[(GDF(218,1)]] – if Field 1 is a string

[[(FORMAT(GDF(218,1),@D18))]] – if Field 1 is a date

[[(FORMAT(GDF(218,1),@N~R~15.2B))]] – if Field 1 is numeric

 

Or

 

[[(GDF(‘Particulars of Claim’,1)]] – if Field 1 is a string

[[(FORMAT(GDF(‘Particulars of Claim’,1),@D18))]] – if Field 1 is a date

[[(FORMAT(GDF(‘Particulars of Claim’,1),@N~R~15.2B))]] – if Field 1 is numeric

 

GetPartyField (GPF)

Returns the contents of a specific field in a Party Extra Screen

Parameters (Description,FieldNo)

where

Description = The Name (or RecordID) of the Extra Screen

FieldNo = The Field number (1-20)

 

Note: This function uses the Party in memory and is only meant to be used in the Extra Screens themselves, e.g. as a Condition, so you know which Party you are referring to.

[[(GetPartyField(107,5))]]

 

or

 

[[(GetPartyField(‘Court Address’,17))]]

 

Or

 

[[(GPF (‘Court Address’,17))]]

 

GetPartyRoleField (GPRF)

Returns the contents of a specific field in a Party Role Extra Screen

 

Parameters (‘Description’,’Role’,Rank,FieldNo)

where

Description = The Extra Screen Description

Role = The Role the party plays on the matter

Rank = The party’s rank, e.g. 1

FieldNo = The Field number (1-20)

 

 

 

The Deponent, in his capacity as [[(GetPartyRoleField(‘Deponent’,’Deponent’,1,1))]], is duly authorized to depose to this Affidavit =

 

The Deponent, in his capacity as Managing Director is duly authorized to depose to this Affidavit

 

PartyTypeDescription (PTD)

Returns the Type of a particular Party.  Return values are listed under Setup | Types, Roles & Entities | Party Types

 

PartyTypeDescription(‘Party,Rank’)

[[IF(PartyTypeDescription(‘Trustee,1’) = ‘Insolvent Estate’)]][[INSOLVENT_ESTATE_SIGNATORIES]] [[INSOLVENT_ESTATE_CAPACITY_PHRASE]] [[SELLER_LINE_IDNOS]] [[INSOLVENT_ESTATE_AUTHORITY_PHRASE]][[ELSE]][[S_NAMES_BLOCK]][[ENDIF]]

 

PartyTypeEntity (PTE)

Returns the RecordID of the Entity of the Party

Returns the Entity of a particular party.  Return values are:-

 

Parameters (‘Party’)

Where

Party = The party in Role.Rank format

 

[[IF(PTE(‘Defendant.1’)=1)]]The party is an adult[[ENDIF]]

PartyTypeStatus (PTS)

Returns the “Status” of a particular Party. Return values are:

M = Male

F = Female

J = Juristic

Parameters (‘Party’)

where

Party = The party in Role.Rank format

[[IF(PTS(‘Defendant.2’)=’J’)]]

You are a juristic person

[[ENDIF]]

CountParties (CP)

Is used to determine how many parties of a certain role are linked to a matter

 

CountParties(‘Role’)

 

[[IF(CountParties(‘Seller’)=2)]]There are two Sellers[[ENDIF]]

FindDate (FD)

Returns a date (forward or backwards) based on working days

 

FindDate(Date,DaysTime,WorkingDaysFlag,SpecificDaysMask)

 

For more information, please refer to the FindDate Function whitepaper which is available on our website

 

Thank you for attending at our offices to sign the Affidavit.  I confirm that matters of this nature are only heard in Court on Thursdays and there is a three week waiting period.  The matter has been set down for [[(GetDayOfWeek(FindDate(GLO:TodaysDate,21,1,4)))]] [[(FORMAT(FindDate(GLO:TodaysDate,21,1,4),@D18))]]

=

Thank you for attending at our offices to sign the Affidavit.  I confirm that matters of this nature are only heard in Court on Thursdays and there is a three week waiting period.  The matter has been set down for Thursday 26 November 2009

 

FindDates (FDS)

Returns a range of dates a starting date.

 

FindDate(StartingDate,HowManyDays,WorkingDaysFlag,SpecificDaysMask)

 

Used mainly by Litigation to offer a list of available court days.

[[(FindDates(MAT:CourtDDate,5,1,4))]]

 

returns

 

Thursday 25 March 2010, Thursday 01 April 2010, Thursday 08 April 2010, Thursday 15 April 2010 and Thursday 22 April 2010

 

when COL:CourtDate = 25/3/2010

GetPlanOfActionDate (GPOAD)

Returns the date for a Plan of Action critical step

GetPlanOfActionDate(‘TheType’.’TheEvent’)

 

Parameters: 

TheType = ‘Actual’ or ‘Target’

TheEvent = the critical step.  Possibilities are:-

Received

Signed

Sent

Lodged

UpForFees

Registered

Returned

 

The Draft Deed was received from the Registering attorneys on the [[(FORMAT(GetPlanDate(‘Actual’,’Received’),@D18))]]

ConvertToWords (CTW)

Converts a numeric variable to words

 

ConvertToWords(Amount,’Type’)

 

 

The amount of [[(FORMAT(MAT:ClaimAmount,@N~R~15.2B))]] ([[(ConvertToWords(MAT:ClaimAmount,’RANDS’))]]) is due and payable =

The amount of R5,000.00 (FIVE THOUSAND RAND) is due and payable

FindDateByMonth (FDBM)

Finds the date in X number of months time

 

FindDateByMonth(TheDate,TheMonths,Exclude weekends/holidays flag)

As instructed, we are pending our file for 3 months.  We will revert further on [[(FORMAT(FindDateByMonth(GLO:TodaysDate,3,1),@D18))]] =

As instructed, we are pending our file for 3 months.  We will revert further on 01 March 2010

FindDateByWeek (FDBW)

Finds the date in X number of weeks time

 

FindDateByWeek(TheDate,TheWeeks,Exclude weekends/holidays flag)

We can expect payment of our costs on or before [[(FORMAT(FindDateByWeek(COL:CourtDate,6,1),@D18))]], which is 6 weeks after the matter was heard in Court =

We can expect payment of our costs on or before 23 November 2009, which is 6 weeks after the matter was heard in Court

EntityDescription (ED or Entity)

Returns the description of the EntityID of the Party

 

EntityDescription(‘Role,Rank’)

 

The First Defendant is a [[(ED(‘Defendant,1’))]]

 

returns

 

The First Defendant is a Private Company

EntityLangDescription (ELD)

Returns the description of the EntityID of the Party in the Default Language of the Party

 

EntityLangDescription(‘Role,Rank’)

 

The First Defendant is a [[(ELD(‘Defendant,1’))]]

 

returns

 

The First Defendant is a Privaat Maatskapy

EntityJuristicFlag (EJF)

Returns 1 if the party’s Entity has the Jursitic flag ticked

EntityJuristicFlag(‘Role,Rank’)

[[IF (ELD(‘Defendant,1’)=1)]]The First Defendant is a Juristic Person[[ENDIF]]

GetMonthName (GMN)

Returns the month of the specified variable

Please find attached your statement for [[(GetMonthName(GLO:TodaysDate))]] =

Please find attached your statement for October

 

GetPartyVariable (GPV)

Returns variable information relating to a specific party

 

GetPartyVariable(‘role,whichone,variable’)

 

For more information, see *Further Notes: GetPartyVariable at the bottom of this document

 

The 3rd Seller’s reference is [[(GetPartyVariable(‘Seller.3.MP:Reference’))]]=

The 3rd Seller’s reference is 7856/8745

 

CheckPartyVariable (CPV)

Checks variable information relating to a specific party

 

CheckPartyVariable(‘role.variable operand value.<screen>’)

 

For more information, see **Further Notes: CheckPartyVariable at the bottom of this document

 

[[IF(CPV(‘Any.MP:RoleID=CTL: SuretyRoleID’))]]There is At least one Party playing the Role of Surety [[ENDIF]]

 

MatterBelongsToGroup (MBTG)

Returns 1 (TRUE)  if the current Matter belongs to a Group with the description of group description

 

MatterBelongsToGroup(group description)

 

 

[[IF(MatterBelongsToGroup(‘Accounting’))]]This Matter belongs to the Accounting Group[[ELSE]]This matter does not belong to the Accounting Group[[ENDIF]]

 

GetLAWMessageDescription (GLMDesc)

Returns the description of a LAW message for the current matter

 

GetLawMesageDescription(number)

 

An [[(GetLawMessageDescription(27))]] message has been received.

 

GetLAWMessageDate (GLMDate)

Returns the date of a LAW message for the current matter

 

GetLawMessageDate(message number)

 

We received the electronic instruction for this Matter on [[(FORMAT(GLMDATE(‘27’),@D17))]]

 

We received the electronic instruction for this Matter on 26/6/2010

GetLastStageDate (GLSDate)

Returns the date of the Last Stage Reached (from File Notes)

The Last Stage reached on this matter was [[(GetLastStageCode())]] – [[(GetLastStageDescription())]] on the [[(FORMAT(GetLastStageDate(),@D18))]] which was [[(GLO:TodaysDate-GetLastStageDate())]] days ago.  [[(GetLastStageFileNote())]] =

The Last Stage reached on this matter was 0020 – Summons on the 16 October 2009 which was 11 days ago.  Service was delayed due to the Sheriff being unable to gain access to the property.

 

GetLastStageDescription (GLSDesc)

Returns the description of the Last Stage Reached (from File Notes)

The Last Stage reached on this matter was [[(GetLastStageCode())]] – [[(GetLastStageDescription())]] on the [[(FORMAT(GetLastStageDate(),@D18))]] which was [[(GLO:TodaysDate-GetLastStageDate())]] days ago.  [[(GetLastStageFileNote())]] =

The Last Stage reached on this matter was 0020 – Summons on the 16 October 2009 which was 11 days ago.  Service was delayed due to the Sheriff being unable to gain access to the property.

 

GetLastStageFileNote

Returns the contents of the File Note of the Last Stage Reached

The Last Stage reached on this matter was [[(GetLastStageCode())]] – [[(GetLastStageDescription())]] on the [[(FORMAT(GetLastStageDate(),@D18))]] which was [[(GLO:TodaysDate-GetLastStageDate())]] days ago.  [[(GetLastStageFileNote())]] =

The Last Stage reached on this matter was 0020 – Summons on the 16 October 2009 which was 11 days ago.  Service was delayed due to the Sheriff being unable to gain access to the property.

 

GetLastStageCode (GLSC)

Returns the Stage Code of the Last Stage Reached (File Notes)

The Last Stage reached on this matter was [[(GetLastStageCode())]] – [[(GetLastStageDescription())]] on the [[(FORMAT(GetLastStageDate(),@D18))]] which was [[(GLO:TodaysDate-GetLastStageDate())]] days ago.  [[(GetLastStageFileNote())]] =

The Last Stage reached on this matter was 0020 – Summons on the 16 October 2009 which was 11 days ago.  Service was delayed due to the Sheriff being unable to gain access to the property.

 

GetYearOnly

Returns the year of the specified variable

Your trademark has been registered and will be up for renewal in [[(GetYearOnly(GLO:TodaysDate)+5)]]. =

Your trademark has been registered and will be up for renewal in 2012.

SUB

Returns a substring of information

 

SUB(string,startposition,length)

SUB('ABCDEFGHI',1,1)   returns 'A'

SUB('ABCDEFGHI',-1,1)  returns 'I'

SUB('ABCDEFGHI',4,3)   returns 'DEF'

 

In a Document:-

 

If the File Reference, i.e. MAT:FileRef = ‘ABC1/0001’

 

[[(SUB(MAT:FileRef,1,3))]]

 

Would return ‘ABC’

 

GetMatterGroups

Returns the Groups that a Matter belongs to

 

GetMatterGroups()

 

This matter belongs to the following Groups:-

 

[[(GetMatterGroups())]]

 

 

*Further Notes: GetPartyVariable

We need to design foolproof documents, i.e. ones that work every time. To do this we have to be specific about exactly which Party variable we are referring to.

 

For example, If you just put [[(PAR:Name)]] in a Document, the program will insert the name of the last Party it had in memory. . . and that could change depending upon what the program did just before it encountered  [[(PAR:Name)]].

 

Likewise, if you use “PAR:EntityID = 1” in a Document Display Condition, it may not work either. When displaying a list of Documents, the program is looping through the Document table, not the Party table so “PAR:EntityID = 1” is meaningless at this place in the program. Note: It might work sometimes if, by chance, the last Party you were working on happened to have the correct EntityID, but it won’t work every time. In software design (and brain surgery) leaving things to chance is not acceptable.

 

There is a  function called GetPartyVariable() which can be used for this purpose. You put the Role and the Rank of the Party before  the variable name so the program knows exactly which Party you are referring to.

 

The syntax is as follows:

 

GetPartyVariable(‘role.whichone.variable’)

 

Alias: GPV

 

Examples:

 

Your name = [[(GPV(‘Selected.Party.PAR:Name’))]]

 

The first seller’s  reference = [[(GPV(‘Seller.1.MP:Reference’))]]

 

[[IF(GPV(‘Defendant.3.PAR:EntityID ’)= CTL:CloseCorporationEntityID)]]The 3rd defendant is a CC[[ENDIF]]

 

**Further Notes: CheckPartyVariable

 

CheckPartyVariable(‘role.variable operand value.<screen>’)

 

Alias: CPV

 

Notes:

 

·         The variable parameter can be any valid Party-related field, e.g. PAR:Name

·         The operand parameter can be any valid operand sign, e.g. =,>,<,>=,<= or <>

·         The value parameter can be another variable (e.g. CTL:AdultEntityID) or a constant (e.g. 1 or ‘‘Yes’’).

Warning: If the value parameter is a string, you must enclose it with double single quotes. This is (because the whole parameter list is already between single quotes, so you need to differentiate between the end of the parameter list and the string. See examples 4 and 5 below.

·         The role parameter can be set to “Any”. This will check all Parties linked to the Matter

·         If the role parameter is set to a certain role, only those Parties playing that role will be checked.

·         If the variable is in an Extra Screen, you need to specify which Extra Screen (because there could be more than one attached to a Party. In this case you must put the name of the Extra Screen as the third parameter otherwise it can be left out (see examples below). The angled brackets in the syntax indicates an optional parameter. The angled brackets themselves must not be inserted in the

 

 

Examples:

 

1)      [[IF(CPV(‘Any.MP:RoleID=CTL: SuretyRoleID’))]]There is At least one Party playing the Role of Surety [[ENDIF]]

 

2)      [[IF(CPV(‘Any.PAR:PartyTypeID=CTL: EstateAgentTypeID’))]]At least one Party is an Estate Agent[[ENDIF]]

 

3)      [[IF(CPV(‘Defendant.PAR:EntityID=CTL: TrustEntityID))]]There is at least one Defendant who is a Trust[[ENDIF]]

 

4)      [[IF(CPV(‘Seller.PAR:MaritalStatus=’’UNM’’’))]]There is at least one unmarried Seller[[ENDIF]]

 

5)      [[IF(CPV(‘Seller.PRS:Field3=’’Y’’.Additional Sale Details))]]At least one Seller has a value of ‘Y’ in Field 3 on the Party Role Extra Screen called “Additional Sale Details” [[ENDIF]]

 

6)      [[IF(CPV(‘Mortgagor.PEF:Field5>0. CRM Continued))]]At least one Mortgagor has a value greater than zero in Field 5 in the Address Book Extra Screen called “CRM Continued” [[ENDIF]]

 

 

KEYWORDS

Keywords can be used in documents to give the document designer more control over the merging process by allowing him/her to ensure the documents contain the necessary information and to optionally abort the document assembly process if a certain condition has not been met.

 

Keyword

Example

[[MESSAGE(message)]]

A message will pop up when merging the document – this is useful to remind the user to, for example, remember to fax a copy of the document to the Opposing Attorney.  The only button available to click on will be the OK button

 

[[MESSAGE(Remember to fax a copy of this letter to the Client for their records)]]

 

 

 

[[WARNING(message)]]

The WARNING keyword will have the heading ‘Warning’ and will BEEP. It will also have YES and NO buttons and will ask the user if they want to abort the document assembly process. If the user clicks on the NO button, the document assembly process will continue. If the user presses YES, the document assembly process will be aborted.

 

[[WARNING(This is a Final Letter of Demand.  Double-check that no payment has been received before sending out the document)]]

 

 

 

[[ABORT(message)]]

This is used to ensure that critical information is filled in prior to assembling a document.  If the criteria are not met, the message will be displayed and the user will have no other option other than to abort document assembly process.

 

 

[[IF(MAT:ArchiveStatus=2)]][[ABORT(This matter has been archived.  Please make the matter live before continuing to assemble any documents)]][[ENDIF]]

 

 

[[TAB]]

This inserts a Tab at the specified point

 

Name:[[TAB]][[(GLO:UserName)]]

[[HRT]]

Inserts a Hard Return at the specified point

 

Name:[[TAB]][[(GLO:UserName)]][[HRT]]Address: