Introduction

When LibraryLink is opened from an existing record, the code and xgType of that record are passed to LibraryLink which returns any linked documents. When using Template Links we use a template in conjunction with a database view to construct a request (file or web) to retrieve documents. At its simplest level we could construct a url to carry-out a Google search for pages relating to a site using the site name. At a less simple level we could search a SharePoint installation for projects tagged with a particular funding source. TIn each case our template contains references to columns in the relevant database view. By editing the design of the database view we can include additional columns to those in the default views.

The database views to edit following the naming convention of dbo.vDOC_xxx for Planning trigrams and dbo.vDOC_xxx_Dossiers for others, where xxx is the trigram of the module being used. The table below lists all views currently in use for Template Links

For example: 

For the Agreements Module (Trigram: OVK), the dbo.vDOC_OVK_Dossiers view contains column headings for:

• AgreementNummber
• PlanUnitCode (i.e. the Site Code)
• PlanUnitName (i.e. the Site Name)
• UnitCode (i.e. the region code used by the site)
• UnitName (i.e. the region name used by the site)

By changing the view we could include additional columns.

url template construction

The template is entered in Admin/Configuration/Template Links tab in LibraryLink.

• Resource Type: File or Web
• Record Type: Also called xgType or just Type on some interfaces. This is a code indicating which object type or module this template applies to.  Valid codes are shown below.
• Name: A user friendly name for the link
• url: The template which includes parameters derived at runtime to construct the url. Parameters are held in curly brackets and will all be column names in the relevant database view.

Examples

• An example url is https://www.google.co.uk/search?q={SiteName} which simply constructs a google search request using the site name.
• Another is D:\temp\ConditionReport_{SiteNumber}.pdf which searches for a pdf document in a folder where the name of the document confirms to the convention in the template.
• https://www.google.com/maps/place/{SiteName} searches Google Maps for places with the site name.
• The following example searches a web resource, perhaps a DMS, for a specific agreement. http://myDomain/sitehandler.aspx?unitcode={UnitCode}&unitname={UnitName}&planunitcode={PlanUnitCode}&planunitname={PlanUnitName}&IsDlg=1&ViewType=Agreement&Code={AgreementNumber}

LibraryLink v4

And below is how they are entered into the configuration for LibraryLink v4.

If the template is not valid, either the url cannot be formed or the base url does not exist, then the link will not display on the viewer in CMSi.

LibraryLink v5

From CMSi Desktop v3.16+, template links can be edited within CMSi.  On the My CMSi Admin section there is a link to Template Links Admin.

This brings up an admin tab where the template links can be created and edited.  These are saved into the database instead of an XML file.

Views for Template Parameters