Explore → Filter → Record
The **Record** view shows all the elements of a recording. The differents fields and associated metadata and possibly relationship between recordings. How to start: - To begin, click on **\[Explore\]**. ① - Perform a search or use a **\[Saved Filter\]** that returns the records you want to include in your report. ① - Select a [**record**](https://heurist-doc.huma-num.fr/6SWzTuSCQtShLJfucCVoUg#) ② - Click on **\[Record\]** ③  Once on the **\[Record\]** view selected, the record’s metadatas appear. There is several informations: - Title ①: title of the record - Icon ②: record’s type icon - **Record H-ID** ②: Intern Heurist record ID - Workflow stage ④ which give some information on the workflow stage - **Media** ⑤: Picture of the media  #### Focus on medias - If a media exists in the **record**, a thumbnail is displayed - It is possible to display in **\[full screen\]**  ① or viewing it in popup  ② - The media can also be displayed on **\[Mirador\]** (using Heurist’s automatic IIIF manifest) ③ or **\[OpenSeadragon\]**  viewer ④ - You can **\[download\]**  it ! ⑤ - By hovering over **\[description\]**, a description appears if this field has been completed ⑥ - Finally by going over **\[rights\]**, the rights of the media appears if it was filled during the record creation ⑦  ##### Click on **\[More…\]** - **Cite as** ① : The record can be cited in XML or HTML. The updating date of the record is shown as the lastest modification date. - **Added** ②: Creation date of the **record** - **Updated** ③: Last **record** update - **Ownership** ④: Communicate who owns the record and who can read it - **Rating** ⑤: You can rate each record from one to five - **Tags** ⑥: You can tag records to find them more easily  ## 2. List viewExplore → List View
**\[List view\]** allows essentialy to show the whole selected data in table format ③. You can choose the field you need ①. You can also save the settings ②. It is also possible to export by simple copy/past (CSV with tab as separator), by excel format and PDF format ③. **🛟** **Tip:** If you want to export data with more export formats, you may want to try the Export view described in the following section.
## 3. Export View The **Export view** allows to export the request results under differents data formats: **CSV ①** **XML ②** **JSON ③** **RDF ④** **GeoJSON ⑤** **KML ⑥** **GEPHI ⑦** **IIIF ⑧** **HuNI ⑨**Several formats can be exported as a data feed, as well as a fixed format file. The data feed capability is particualrly useful for sending live data to a processing workflow, often combined with a saved search which filters the required set of output records. It can be a very useful, simpler alteraitv eto usign th Heurist API.
 ### CSV / TSV (Delimited) files When you click on **\[CSV\]**, a pop-up opens allowing you to choose the fields you want to export and a range of settings.Note that by default CSV files are exported as tab-separated, since this causes much fewer problems with complex text (which often contains commas and unmatched quote marks, but very rarely contains actual tab characters)
CSV/TSV exports are a particularly good way of temporarily exporting some fields, carrying out some manipulation in an externa program eg. a spreadsheet, Open Refine or R, and reimporting the results with Populate > Import - Delimtied text / CSV. Because all exported CSV/TSV files automatically include the Hursit ID (H-ID)\_ which is uniqiue to each record, it is very easy to reimport the data into the soure records, overwriting or adding to existing values in the same or differnet fields.
First, you must choose the records you want to export ①. You can choose between the current result set and any single type of record occuring within the resultset.We STRONGLY recommend only exporting one record type at a time. Delimited files are really not meant for dealing with heterogeneous data, and mixed exports will restrict the exportable fields to record metadata and shared fields.
[](https://docs.heuristref.net/uploads/images/gallery/2026-07/rLHimage.png) After the records selection, you choose one of the two available export settings ② : \- a single joined file \- a file by record type (if multiple types are selected). You can choose to display the fields in either Form order (the default) or alphabetic order. Alphabetic order may make it easier to select fields in some circumstances. The main step of the export setting is to select the fields you want to export ③ . They can be any type of field including the constructed title, **record pointers** and **relationship markers**. You can export metadata about the records ④ as well as the data from the data fields ⑤ .If you have a current resultset with more than one record type in it, you will only be able to choose the metadata and fields which are shared by all the record types in the resultset.
If the record type you are exporting contains record pointer or relationship marker fields, you can drill down into those record types and export fields from within those records. They can be included in the main file ("single joined file") or exported as separate files with linking IDs ("File by record type").You should use "File by record type" where there are multiple values in record pointer fields, since the values in each related record will need to be kept separate. For simple cases without repeated value record pointers "single joined file" may be appropriate.
[](https://docs.heuristref.net/uploads/images/gallery/2026-07/PUoimage.png) Note how you have some additional options appearing on the right against any selected fields. For most purposes you will want to use *Value*, as the other options can be done more effectively in an external spreadsheet. However *Group by* will group records into a single record for each value encountered in the column, while *Count* will count the number of occurrences for the field in those groups. The results can be a little hard to interpret.**🛟 Tip:** The H-ID is ALWAYS included in the export because it uniquely identifies every record, so it is essential if you need to import/update data back into the database or to make links between records eg. record pointers
Finally, when ending the CSV export setting, you can change the field/column delimiter for the csv (for example: tab, semicolon, comma, etc.) and character used for quotemarking the textual content. You can also save settings ⑦ by giving it a name in order to use it later. [](https://docs.heuristref.net/uploads/images/gallery/2026-07/DXyimage.png) **Handling of record pointers and relationships** For all other export types, it is possible to choose between: - - Export the records and their relationships (relationship of the type pointer or the relationships maker) - Export only the pointer relationships - Don’t follow the pointer relationships or the relationships makers - Follow all relationships including inverse pointers (🚨**warnings**: it could export the entire database) [](https://docs.heuristref.net/uploads/images/gallery/2026-07/qwUimage.png) ### XML “**Extensible Markup Language (XML)** is a markup language and file format for storing, transmitting, and reconstructing data. It defines a set of rules for encoding documents in a format that is both human-readable and machine-readable.” (source: [**Wikipedia**](https://en.wikipedia.org/wiki/XML)) Heurist defines an XML schema called Heurist Markup Language (HML). HML can be used both as an interpretable archivable format (it is included as the primary element of Publish > Safeguard file) and as a data source which can be transformed with XSLT transforms, Python, PHP, or many other languages to a required format. Check the box "Include human-readable names and local IDs for everything" if you plan to look at the XML file and interpret its structure (this will create a very large file duer to repetition). It is often better to export an explanation of the structure through Populate >Heurist XML/JSON - Download template. [](https://docs.heuristref.net/uploads/images/gallery/2026-07/P0Jimage.png) ### JSON “**JSON (JavaScript Object Notation)** is an open standard file format and data interchange format that uses human-readable text to store and transmit data objects consisting of name–value pairs and arrays (or other serializable values).” (source: [**Wikipedia**](https://en.wikipedia.org/wiki/JSON)) The choices are similar to XML/HML, except that it cannot include the human readable forms. However, as with XML, you can download the information in the form of a JSon tempalte through Populate >Heurist XML/JSON - Download template. ### RDF “The **Resource Description Framework (RDF)** is a method to describe and exchange graph data.” (source: [**Wikipedia**](https://en.wikipedia.org/wiki/Resource_Description_Framework)) In this format, you can specify the serialisation you want: rdfxml, json, ntriples or turtle As this function is still in development (July 2026) it requires a special password to access. Contact the Heurist development team for further information. #### GeoJSON “**GeoJSON** is an open standard format designed for representing simple geographical features, along with their non-spatial attributes. It is based on the JSON format.” (source: [**Wikipedia**](https://en.wikipedia.org/wiki/GeoJSON)) You can select the export detail between: No = no detail, Inline = Inline detail, and Full = maximum detail ### KML “**Keyhole Markup Language (KML)** is an XML notation for expressing geographic annotation and visualization within two-dimensional maps and three-dimensional Earth browsers. It is best known for its use in Google Maps but is widely importable into GIS and mapping packages” (source: [**Wikipedia**](https://en.wikipedia.org/wiki/Keyhole_Markup_Language)) There are no options for this export format, it is exported immediately as soon as you click on the button. ### GEPHI GEPHI export generates a GEFX file which can be loaded immediately into GEPHI. Note that this export function is also available directly within the network visualisation graph in the **Network** tab. [](https://docs.heuristref.net/uploads/images/gallery/2026-07/GE2image.png) In addition to the normal node and edge fields, you can choose to add additional fields to the export ①.  This leads to the pop-up below. We recommend only selecting fields relevant to the record type being exported. You can also export with jsut the default fields ② which will be sufficient in most cases. [](https://docs.heuristref.net/uploads/images/gallery/2026-07/SQ3image.png)**🛟 Tip:** It can be useful to check the box limiting the export to the first 1000 nodes in order to check that the export gives you what you want in GEPHI, befor exporting a very large dataset.
### IIIF “The International Image Interoperability Framework (IIIF, spoken as ‘triple-I-F’) defines several application programming interfaces that provide a standardised method of describing and delivering images over the web, as well as “presentation based metadata”\[1\] (that is, structural metadata) about structured sequences of images” . (source: [**Wikipedia**](https://en.wikipedia.org/wiki/International_Image_Interoperability_Framework)). IIIF can also handle tiled image delivery andimage annotation. Heursit acts as both a IIIF manifest delivery system and image server, and as an IIIF display and annotation client, notably through the use of Mirador Vsn 4 and Open Sea Dragon viewers, and the MAE annotation framework. Heurist can also read and atomise manifests containing annotations, and recompose manifests including those annotaitons and others created within Heurist. IIIF is a rich and complex system. Heurist's IIIF implementation is discussed in detial in chapter 8e. ### HuNI “**HuNI** (pronounced “honey”) brings together information about the people, works, events, organisations and places that form Australia and Canada’s past and present.” (source: [**huni.net**](https://huni.net.au/#/search)). It is an old infrastrucute project dating to the 2000s with limited functionality (essentially harvesting simple metadata from 40+ Australian sources, providing simple search, bookmarking as a 'collecction' and exporting a CSV file with title and URL of the bookmarked records. The HuNI export format has the particularity of exporting one XML file per record. It may be of some use if that fits with your needs. #### HTML This option exports HTML pages for public records (one file-per-record) using the Record view format. **📊 Export‑type quick‑reference table – Which format to choose?**| Need | CSV | XML | RDF | JSON | GeoJSON | KML | Gephi | IIIF | HuNI |
|---|---|---|---|---|---|---|---|---|---|
| Spreadsheet | ✅ | ✅ | |||||||
| Markup (tagging) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ||
| Versatile (generic data) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | |
| Spatial (geographic) | ✅ | ✅ | |||||||
| Networks | ✅ | ||||||||
| High‑resolution images | ✅ |
The development of custom reports can be quite a slow process, so it is best to plan well what reports you need and apply good naming conventions. Some level of simple HTML will be required, and knowledge of CSS will allow for much greater control of the output. PHP and JS functions can also be included (optional).
**Custom Reports** are useful when you need to extract and format specific data for further analysis or publication. They are particualrly useful in formatting data to appear in web pages (see chapter 9). They can also be used to download formatted information or set up feeds of data for other purposes. They are also useful for displaying a single record in Record View, a popup on the map, or wherever data needs to be displayed in response to selection of one or more records.Tip : Before creating your Custom Report, define clearly what sort of display you plan to do. Your formatting goal will determine both the data you select and the way you format the output.
Reports are built using **Smarty**, a templating language that combines standard **HTML** with **Smarty tags** to dynamically insert data from Heurist. You may see this message above your report format in the middle panel. CSS and JS are disabled by default in report formats and websites generated by a database as a security precaution, to avoid unwanted actions from parasitic databases. If you wish to use these - many websites will want to customise their appearance or behaviours more than the default settings allow - you should contact the server adminstrator who will add the database to a list of authorised databases. [](https://docs.heuristref.net/uploads/images/gallery/2026-07/dNGimage.png)If you change the name of a database, clone it or create a new database it will not allow CSS or JS. The new name will need to be added to the list.
--- ### How to start : In the Explore menu ① you can focus on a specific record type (Explore > Entities) and select the record type from the list ② You may wish to perform a more flexible filter, either by entering it in the Filter field ③ or using the Filter builder or Facets builder just below it, or use a \[Saved Filter\] from the Filters ection ② that returns the records you want to include in your report. The selected records will appear in the middle section of your screen. ④ To work with Custom Reports, click on the \[Report\] tab ⑤ The Custom Report template for your filtered data will appear below the \[Report\] button. The report shown in the backend interface is limited to 50 records by default (can be increaed to 200 or 500 in Design > My Preferences) and ends with a line stating this limit, as it is really designed as a preview function. To view the full results click the globe or download icons - see below).
### The Toolbar In the upper part of the **Custom Report** tab, you’ll see a toolbar: [](https://docs.heuristref.net/uploads/images/gallery/2026-07/uW2image.png) #### Edit Tool  Click \[Edit\] to open the template editor and start writing your **Custom Report** with **Smarty**. The editor is split into three panes ①, ⑤ and ⑨ :::info Tips : **Actions pane** ① : Insert fields, loops, and conditions via dropdown helpers ②, and a tree view ④ selected with the record types dropdown ③ The tree view ④ allows you to select multiple fields, including from the metadata attached to each record (ID, date of addition, owner etc.), the method of representation of term fields (label, description, code), and to drill down into connected records through record pointer fields or relationship markers. [](https://docs.heuristref.net/uploads/images/gallery/2026-07/TyOimage.png)The fields can be organised in record form order (default view, showing the tabs and headings in bold font), or in alphabetic order. The tree can also show record types which have record pointers pointing TO the record type selected (*Show linked-from record types* checkbox)
Having selected one or more fields, make sure the cursor is positioned where you want them inserted in the report format and click **Add selected fields.** This will display the following popup; [](https://docs.heuristref.net/uploads/images/gallery/2026-07/kSWimage.png) By selecting the checkboxes you can accompany insertion with various additional functions and pieces of information - the two selected by default will be useful in many cases to get some sort of reasonable default output. Fields can be inserted one-by one (**Insert field**) allowing the accompanying information to be changed between fields, or you can insert all the remaining fields with the same accompanying information by clicking **Insert all**. Fields can be omitted with **Skip**. The **pattern insertion dropdown** ② above the treeview function allows insertion of a number of simple html patterns such as tables and record links, as well as patterns to carry out some action eg. writing some label or separator, at the beginning or end of a loop. Note that the list of available patterns may change as new capabilities are added. [](https://docs.heuristref.net/uploads/images/gallery/2026-07/jBpimage.png) **Editor pane** ⑤ : write and edit your HTML + Smarty template here. In the editor, you’ll see the template you selected or the default starter message/template (note that this template may change through time as we improve on it, but it will contain a basic loop for records and some instructions at the end to help you get started). *{\* This is a simple Smarty report template which you can edit into something more sophisticated.* *It should give basic output for any database, as it uses the standard record types which are part of all databases.* *Enter html for web pages or other text format. Use tree on the left to insert fields, loops and tests.* *Use this format to include comments in your file, use <!-- --> for output of html comments.* *Smarty help describes many functions you can apply, loop counting/summing, custom functions etc. \*}* *For Smarty syntax please see the following chapter (8b).* **Preview pane** ⑨ : shows the output when you click \[Test\] ⑧ . You can choose to truncate the preview to *n* records ⑥ and select how to handle debug messages, warnings, and errors ⑦. Click \[Test\] to preview ! Nothing is saved when testing. Use \[Save\] (or \[Save As\]) to store your template and keep versions. Use Ctrl+Z / Cmd+Z to undo recent edits. You can undo a lot of edits by repeating this.
**We strongly recommend using the test function frequently** making only one or two changes at a time and clicking Test to see the results. If somethign doesn't work, you can immediately undo it and try an alternative. Undo can be applied repeatedly. Don't get tempted to write a lot of code and then test it because then you will have trouble finding the problem.
#### Rename [](https://docs.heuristref.net/uploads/images/gallery/2026-07/9HTimage.png) Allows renaming of an existing template. Note that if a template is renamed, any URL or scheduled regeneration which uses the old name will fail. #### Create a new template  \[Create a new template\] works similarly to the \[Edit\] tool. It opens the same editor interface where you can create a new Custom Report template from scratch. Use it when you want to **start a fresh layout** instead of editing an existing one. *For Smarty syntax please see the following chapter (8b).* #### Delete the Selected Template  The \[Delete\] tool allows you to **delete** the currently selected template. When clicked, a **warning message** will pop up asking for confirmation.  It will display the name of your template ① like *name\_file\_.tpl* . As here for exemple "Basic (inital record types).tpl" Click \[Proceed\] to confirm deletion, or \[Cancel\] to abort the action. #### Import and Export Templates  The Import ← and Export → tools allow you to share and reuse Custom Report templates. For this we have developed a 'global template' format (.gpl) which uses Heurist's unique Concept IDs so that the template can be usd by any database that includes those concepts (definitions of record types, fields and terms). Template files stored in the Heurist database are the same as global files except that they use local codes rather than the unique global concept IDs.Templates can only be exported from a registered database to ensure that there are Concept IDs for any definitions used in the template. If the database is not registered you will see the following message.
 Import lets you upload an existing global template file (.gpl) and convert it to a local template file (.tpl) Export lets you download your customized template as a .gpl file, so you can back it up or share it with others. ##### Obtain the URL, JavaScript to embed a report, and set a publishing schedules  The \[Publish\] option lets you : - embed a Custom Report in an external website in another CMS - schedule periodic regeneration with caching for faster load times on large/complex reports. [](https://docs.heuristref.net/uploads/images/gallery/2026-07/RQIimage.png) ##### Embedding The dialogue above gives an iframe instruction to embed the report into another website. Switching to *javascript wrap* will give an alternative text such as: [](https://docs.heuristref.net/uploads/images/gallery/2026-07/cwCimage.png) The Open in new window link is a useful way of seeing the report cleanly and for obtaining a URL for use elsewhere. The Content-type dropdown allows a number of differnt output formats to be specified, setting a parameter on the URL used by Open in new window. html and text are the two most useful, the others produce generic outputs which may or may not be of any use. To obtain text output, do not include any html tags in the report format. [](https://docs.heuristref.net/uploads/images/gallery/2026-07/mMfimage.png) ##### Setting up a scheduled (cached) report ###### Pros/cons of schedulingMuch faster for large tables, complex calculations, or media-heavy pages.
Content is a snapshot at the last generation time (not strictly real-time), so frequency of update needs to be approriately set
The first screen shows any existing scheduled actions: [](https://docs.heuristref.net/uploads/images/gallery/2026-07/DQtimage.png) Adding a new report schedule pops up a dialogue to define the parameters of a new schedule using the current filter ("Query") with a number of different options - a title to identify it, the report template to be used, the frequeny with which to regenerate the output (the default value of 1440 minutes = daily, 0 = only manual regeneration, which is useful for data that will never, or very rarely, change). [](https://docs.heuristref.net/uploads/images/gallery/2026-07/G3bimage.png) #### Download [](https://docs.heuristref.net/uploads/images/gallery/2026-07/CMoimage.png) This allows the download of a plain text file without html formatting (assuming you did not use html tags in the report format) #### Print  The \[Print\] buttom simply generates a PDF of the output from your current **Custom Report** template. It’s a quick and convenient way to export information in an easy readable and shareable format.Tip: Don’t hesitate to use this feature to: Enrich your Data Management Plan (DMP), Place in a hardcopy archive, Keep track of specific datasets, or Share information with colleagues who may not be comfortable navigating Heurist or other “sophisticated” data formats.
#### Refresh  Click on the \[Refresh\] buttom to update the data used by your Custom Report template. For filters other than Facet filters (where you must make surther selections) you may also simply hit the Filter button to rerun the filter, which will cause the report to be rewritten. If your database has been modified (new records, edits, deletions) but the output of your report does not reflect these changes, simply hit Refresh to reload the most recent data and ensure your preview is accurate. # 8b: Custom reports - Advanced functions ### Advanced topics in custom reports Note (July 2026): the content was copied via markdown export and lost much of its minor formatting. The images in particular have been downgraded. The original source is here: [https://docs.google.com/document/d/1Jyytaln1-aCm3paZ4rBKho0puXBGaJ97/edit](https://docs.google.com/document/d/1Jyytaln1-aCm3paZ4rBKho0puXBGaJ97/edit) This chapter contains lots of undigested tips for advanced users, skip the first 10 pages or so to get to this material. ### Smarty Syntax If you are not familiar with Smarty or the Smarty syntax, the [Smarty Site ](http://www.smarty.net/)has a range of information and resources on using the Smarty Report Template Engine, including complete Smarty documentation. This topic provides an introduction to some basic syntax elements when you are using the Actions Pane to create simple reports. #### ***Advanced features*** SMARTY provides a range of features that can improve your reports. For a full explanation, visit the [SMARTY documentation](https://www.smarty.net/docs/en). #### ***Template plugins*** Template plugins provide advanced template functionality. Template plugins include: - Functions - Block Functions - Modifiers Plugins are always loaded on demand. Only the specific modifiers, functions, resources, etc. invoked in the templates scripts will be loaded. Moreover, each plugin is loaded only once, even if you have several different instances of Smarty running within the same request. #### ***Main records*** The foreach statements enclose a loop which outputs information for each record in the query result. Fields can be inserted with the insert links next to each field. Use the if links to insert tests based on the value of a field (e.g.. to only output text if a field is set). #### ***Subrecords*** Further loops can be inserted to output multiple sub-records within the main record loop, using the loop link after the subrecord name. Fields within sub records can be inserted with either the in or out links; use the in link to insert a field within a loop, use the out link to insert a field outside a loop. #### ***Comments*** Syntax: {\* This is a comment \*} Comments are useful for making internal notes in your template. They are completely ignored in your template file and are invisible to public view (unlike <!-- HTML comments -->). #### ***Variables*** Synatx: $foo Variables allow you to dynamically replace the variable by data when the web page is created. For example, instead of writing the record title in the template, you can use a tag like {$title} in place of the title. Variables can contain numbers, letters and underscores. You can apply maths to variables that contain numbers. For example: {$foo+1} {$foo\*$bar} {$foo->bar-$bar\[1\]\*$baz->foo->bar()-3\*7} Smarty has several different types of variables. The type of the variable depends on what symbol it is prefixed or enclosed within. Variables in Smarty can be either displayed directly or used as arguments for functions, attributes and modifiers, inside conditional expressions, etc. To print a variable, simply enclose it in the delimiters so that it is the only thing contained between them. ##### **Arrays in Smarty reports** - You may use arrays in smarty report easily. Access element by its index First element: {$newValue\[0\]}<br> Or use standard array functions. ``` Print array: {print\_r($newValue,true)}\| Qualifier | Syntax Example | Meaning |
|---|---|---|
| == | $a eq $b | equals |
| != | $a neq $b | not equals |
| > | $a gt $b | greater than |
| < | $a lt $b | less than |
| >= | $a ge $b | greater than or equal |
| <= | $a le $b | less than or equal |
| === | $a === 0 | check for identity |
| ! | not $a | negation (unary) |
| % | $a mod $b | modulous |
| is \[not\] div by | $a is not div by 4 | divisible by |
| is \[not\] even | $a is not even | \[not\] an even number (unary) |
| is \[not\] even by | $a is not even by $b | grouping level \[not\] even |
| is \[not\] odd | $a is not odd | \[not\] an odd number (unary) |
| is \[not\] odd by | $a is not odd by $b | \[not\] an odd grouping |
Calculate fields are not updated on record import. You will need to rebuild calcualted fields after import with Admin > Rebuild calculation fields
- Configure a ‘Weekday’ dropdown for the [Mary Hamilton Project](https://heurist.huma-num.fr/heurist/?db=Mary_Hamilton_Project). A simple vocabulary of the seven days of the week, then defined this formula for the field: {$date = $r.f9} {$date->format(‘l’)} {date\_format(date\_create($r.f9),"l")} - for weekday as word {10630+date\_format(date\_create($r.f9),"N")} - for weekday as enum value #### Bootstrap Bootstrap is now incorporated as components in website format Vsn 3, but for older websites this may be useful. Is there a way of using Boostrap without messing up the CMS? CSS is not enough. Bootstrap is javascript library and affects all elements besides css. It creates its own widgets for buttons, inputs etc. Fortunately since v5 it is jquery free otherwise v4 may load its own jquery jquery-3.3.1 and it conflicts with ours OK. There is $.fn.button.noConflict(); in bootstrap that resets the appropriate element to original mode. #### Manual rendering of file fields You may encounter situations in which the 'wrap' function does not behave as you would wish. In such a situation, you can manually control how the file field is rendered. Click below for details. Manually accessing data in file fields: A common application of this is to include information from the description of an uploaded file in the Custom Report. For example, when uploading an image, you might include image credits in the description of the file, or a caption to be displayed, or alt text for screen readers. To include this data in your custom report, you would use the 'ulf\_Description' key, like so: {$r.f38\_originalvalue\[0\]\['ulf\_Description'\]} ### Linked and Related Records There are different ways that Heurist records can be linked to one another. In the simplest case, a record can have a 'record pointer' field, which simply points to another record. For example, a book may have an author field. Rather than containing a name, the 'author' field simply contains the id number of the Person who is the author of the book. #### Using Record Pointers in the Current Record When writing a custom report, it is easy to insert records that the current record points to, simply by using the field browser on the left of the screen. Simply choose which information you would like to include from the linked record, and use the 'insert field' tool. Heurist will insert some code that looks a bit like this: {$f1000=$heurist->getRecord($r.f1000)} Here is a detailed breakdown of the code: - $f1000 ☚ The variable where you will store information about the new record. Heurist will give it a default name based on how the information is stored in the database. In this example, the book's author is stored in Field 1000, so $f1000 is used. You could change this to $author to make your code easier to read - $heurist->getRecord ☚ Retrieve authors information from the database - $r.f1000 ☚ The author's ID number, which is stored in Field 1000 of the book record. As the main record type in the Custom Report, the book has simply been labelled $r. If the field is repeatable, then you should click the 'repeatable' link in the field selector tool, which will insert code that looks something like this: {foreach $r.f1000s as $f1000 name=valueloop} {$f1000=$heurist->getRecord($f1000)} {\* Do something with each $f1000 (i.e. author in this example \*} {/foreach} This is very similar to the above code, except that there is a foreach loop, and instead of asking for the information in $r.f1000, you request information in $r.f1000s, the plural form. #### ***Linked Records*** The situation is more complex, however, if you wish to fetch information from \*other \*records that point to \*this \*one. For instance, suppose you want to display information about a Book. Part of the information you wish to display is information about the libraries that hold this Book. But in your database, information about library holdings is held in the Library record type. For instance, if you open up the 'New York Public Library' record, and look in the 'Books Held' field, you will see a list of all the books held by that library. When it comes time to display information about a particular book in a custom report, how can you retrieve information about all the Libraries that hold that book? To solve this problem, Heurist provides the getLinkedRecords method. The code snippet below would retrieve a list of every library that holds the current book, and then put the name of each library into a bullet-point list: <p>Libraries holding this book:</p> <ul> {$libraries = $heurist->getLinkedRecords($r.recID, 25, 'linkedfrom')} {foreach $libraries\['linkedfrom'\] as $library} <li> {$library\_details = $heurist->getRecord($library)} {$library\_details.f1} </li> {/foreach} </ul> Feel free to copy that code into your own Custom Report and make appropriate modifications. Here is a line-by-line breakdown of the code: - <p>Libraries holding this book:</p> ☚ This creates a heading for the list of libraries. You could also use a subheading element such as <h2> or <h3> - <ul> ☚ This tag begins the bullet point list. Every item inside it will be included in the list. Every such item should be enclosed in <li> tags. - {$libraries = $heurist->getLinkedRecords($r.recID, 55, 'linkedfrom')} ☚ This line fetches information about all the libraries linked to the current book. Here is a more detailed breakdown: - $libraries ☚ The name of the variable where you will store all the libraries' ID numbers - $heurist->getLinkedRecords ☚ The method for finding linked records, which is stored inside the $heurist object - $r.recID ☚ The record ID of the current record you are looking at, which is assumed to be a book for this example - 55 ☚ The RecordTypeID for the 'Library' type in this database. By putting this 55 here, you are telling Heurist only to look for \*Libraries \*that point to this book, as opposed to \*Bookshops \*or \*Persons \*or any other record type that may also point to Books in your database. To find the Record Type ID for a particular record, go to the [Record Types ](https://heuristref.net/h6-alpha/viewers/smarty/636)tool in the [Design Menu ](https://heuristref.net/h6-alpha/viewers/smarty/635). If you don't provide a number, then Heurist will simply retrieve every record connected to this one. If you wish to search for multiple record types, you can provide an array in square brackets, e.g. \[55, 66, 81\]. - 'linkedfrom' ☚ This tells Heurist only to look for records that \*point to \*Books (i.e. to find records that this Book is \*linked from \*). You can also ask Heurist to find all records 'linkedto' this record. If you don't provide Heurist this clue, then it will simple find all records linked to this Book, whether it is the other record that points to the book, or the book that points to the other record. - {foreach $libraries\['linkedfrom'\] as $library} ☚ Loop over each library that this book is linked from, and do something each time - <li> ☚ Create a new bullet point - {$library\_details = $heurist->getRecord($library)} ☚ Retrieve the current library's details - {$library\_details.f1} ☚ Put the library's name in the bullet point - </li> ☚ The bullet point is now finished - {/foreach} ☚ That is all we want to do with this library – now go back to the start of the 'foreach' loop and do the same again for the next library, until all a dealt with - </ul> ☚ After creating a bullet point for each library, close the list. #### ***Related Records*** A similar problem is posed by Record Relationships. These are complex interrelationships between records, and are not actually stored in the records themselves. Instead, there is a seperate table in the underlying database, which stories information about every Record Relationship. If you wish to retrieve this relationship data, we provide the $heurist->getRelatedRecords method. Let's say you are building a new custom report, displaying information about authors in your Books database. If you wished to display information about an author's relatives, you could write: <p>Author's relatives:</p> <ul> {$relatives = $heurist->getRelatedRecords($r)} {foreach $relatives as $relative} <li> {$relative.recRelationType} : {$relative.f1} </li> {/foreach} </ul> This example is very similar to the getLinkedRecords example, so I will just pick out a few details that are different: - {$relatives = $heurist->getRelatedRecords($r)} ☚ This fetches every record that is directly related to this record ($r), and stores the information in a new array called $relatives. - {foreach $relatives as $relative} ☚ Now we loop over the array, to create a bullet point for each relative - {$relative.recRelationType} ☚ All relationships have a RelationType, e.g. 'isMotherOf' or 'wasParticipantIn'. You can retrieve this information with .recRelationType - {$relative.f1} ☚ Assuming that the $relative is a Person, this would insert their surname into the report - {$relative.recRelationType} : {$relative.f1} ☚ Taken together, this would insert the type of relationship, a colon and then the surname of the relative into the report, e.g. isMotherOf : Smith. \*\*NB: \*\*As you can see, there is no need to use $heurist->getRecord when using the $heurist->getRelatedRecords method. This method returns \*all \*the information about each related record, not just the record ID of each relative. Contrast this with the above examples of Record Pointers and Linked Records. #### Examples - I want to use the title (or the family name) of the Person who was interviewed to insert in the Interview extract (Extract is child of interview is child of person). Interview has a pointer to Person that has a title (Family Name = field #1), so you first need to load the person record, then you can access the family name or other fields in Person. {$person=$heurist->getRecord($f247.f15)} {\* Person \*} {$person.f1} {\*Family name \*} - How do you retrieve fields from the relationship record (as well as the related record). getRelatedRecords returns an array of related records with additional header fields: recRelationType\*, recRelationNotes, recRelationStartDate, recRelationEndDate. {$rel\_record = $heurist->getRecord($Relationship.recRelationID)} {$src\_info = $heurist->getRecord($rel\_record.f1160)} Source de l'Information: {$src\_info.recTitle} {\* Get infromation from the relationship record \*} {$rel\_record = $heurist->getRecord($Relationship.recRelationID)} {$src\_info = $heurist->getRecord($rel\_record.f1160)} Source de l'Information: {$src\_info.recTitle} Start Date: {$rel\_record.f10} End Date: {$rel\_record.f11}  #### ***Sorting related records*** In smarty reports, when dealing with a {foreach} loop calling child records, you may need to order the resulting set based on a specific variable/field from the child record eg. producing a list of child records ordered alphabetically by author. {\* Bibliographic references \*} {if ($r.f1016s)} {$bibs=array()} {foreach $r.f1016s as $bibRef name=bibLoop} {$reference=$heurist->getRecord($bibRef)} {$bibs\[$reference.recID\] = $reference.recTitle} {/foreach} **{capture}{asort($bibs)}{/capture}** <section class="references"> <p><strong>Bibliographical References:</strong></p> <ul> {foreach $bibs as $bib\_id=>$bib\_title name=bibLoop2} <li>{$bib\_title} <a href=https://Heurist.Huma-Num.fr/judaism\_and\_rome/view/{$bib\_id} target=\_blank>view</a></li> {/foreach} </ul> </section> {/if} V2 - > r in second for loop can be used in the same way as in any other for loops of records $repeatsorted=array()} {foreach $repeat as $item name=valueloop}{\* \*} {$item=$heurist->getRecord($item)} {$repeatsorted\[$item.recID\] = $item.recTitle} {/foreach} {capture}{asort($repeatsorted)}{/capture} {foreach $repeatsorted as $itemsorted name=valueloop}{\* \*} {$r=$heurist->getRecord($itemsorted@key)} {/foreach #### \*\*\*To get info from the relationship record \*\*\* (I've added this to z\_Ian\_Text report): Use h6-alpha {\* Get infromation from the relationship record \*} {$rel\_record = $heurist->getRecord($Relationship.recRelationID)} {$src\_info = $heurist->getRecord($rel\_record.f1160)} Source de l'Information: {$src\_info.recTitle} Start Date: {$rel\_record.f10} End Date: {$rel\_record.f11} I have put in rubbish dates 1111 and 9999  getRelatedRecords returns an array of related records with additional header fields: recRelationType, recRelationNotes, recRelationStartDate, recRelationEndDate. Note that when using getRelatedRecords and getLinkedRecords, it is not possible to detect what relationship marker field generated the particular relationship. We don't keep this info. You may filter out the required record by rectype and relation type #### **Detecting if a linked record is visible to public** - Detection, in a custom report, whether a linked record is visible to the public ``` **{foreach $r.f1107s as $f1107 name=valueloop}{\* Other sources \*}** **{$source=$heurist-\>getRecord($f1107)}** **{if ($source.recNonOwnerVisibility=='public')}** ``` or: {if ($source.recIsVisible!==false)} {\* Hide non-public related sources if not logged in \*} ### Advanced HTML, CSS and JavaScript To unlock the full power of the Custom Report tool, you need to have CSS and JavaScript enabled for your database. To do this, please contact your server administrator. On the Sydney and Huma-Num servers, the administrator is [ian.johnson@sydney.edu.au ](mailto:ian.johnson@sydney.edu.au). If you are using a hosted version of Heurist at another institution, you will need to inquire there about who has adminstrative rights. Along with HTML, JavaScript and CSS are the building blocks of the web. JavaScript is a fully-featured programming language with inbuilt tools for interacting with web pages through the Document Object Model (the DOM). CSS (or 'Cascading Style Sheets') is a simple formatting language that allows you to describe how you would like different page elements to be formatted. There are many ways you can embed JavaScript and CSS into a Heurist website. For a full discussion, please visit the [JavaScript ](https://heuristref.net/h6-alpha/viewers/smarty/664)and [CSS ](https://heuristref.net/h6-alpha/viewers/smarty/666)pages of this help system. Once you have enabled JavaScript and CSS, you can structure your reports using more advanced features. Note that the custom JS and CSS defined at the site or page level (in CMS Home or CMS Menu\_page) are not applied to custom reports. You must add the needed CSS and JS code directly in the report. Note that you will not be able to use php code and functions within smarty on Heurist. Most php functions have been restricted for security issue. Please contact the Heurist development team should you need to use php code. #### ***Using Advanced HTML Elements*** By default, you are able to use the following tags to structure your Custom Report: - [<h1> - <h6> ](https://www.w3schools.com/tags/tag_hn.asp)for headings - [<p> ](https://www.w3schools.com/tags/tag_p.asp)for paragraphs - [<a> ](https://www.w3schools.com/tags/tag_a.asp)for links - [<ul>](https://www.w3schools.com/tags/tag_ul.asp) for bullet points and [<ol>](https://www.w3schools.com/tags/tag_ol.asp) for numbered lists, along with the crucial [<li>](https://www.w3schools.com/tags/tag_li.asp) tag for each item in the list - [<span> ](https://www.w3schools.com/tags/tag_span.asp)for spans (e.g. for highlighting particular text) - [<strong> ](https://www.w3schools.com/tags/tag_strong.asp)for making text bold, and <em> for italicising it - [<div> ](https://www.w3schools.com/tags/tag_div.asp)for divisions - [<table> ](https://www.w3schools.com/tags/tag_table.asp)for tables. There are many other tags that need to be used to make tables work. The most important are [<th> ](https://www.w3schools.com/tags/tag_th.asp), [<tr> ](https://www.w3schools.com/tags/tag_tr.asp)and [<td> ](https://www.w3schools.com/tags/tag_td.asp), which allow you to define table headings, rows and datapoints. Click though the link to see information about other more advanced features of html tables. - [<img> ](https://www.w3schools.com/tags/tag_img.asp), [<audio> ](https://www.w3schools.com/tags/tag_audio.asp)and [<video> ](https://www.w3schools.com/tags/tag_video.asp)elements introduced using the [Wrap Function ](https://heuristref.net/h6-alpha/viewers/smarty/showReps.php?db=Heurist_Help_System&w=a&q=t%3A52&publish=1&debug=0&template=Content.tpl&mode=html#h_79599601516321645667800723). Once you have enabled JavaScript and CSS, however, you can consider using more advanced HTML tags to structure your report. Some of these elements include: - [<article> ](https://www.w3schools.com/tags/tag_article.asp)– This element is ideal for wrapping a single result. For instance, if your custom report will output a list of Persons, the results for each Person will be inside an <article> element. This helps screen readers and search engines interpret the structure of your page. NB: Each article should have exactly one <h1> element inside it, for the 'title' of the article. - [<section> ](https://www.w3schools.com/tags/tag_section.asp)– Divisions are arbitrary elements, than can serve any number of roles. If you wish to deliberatly divide the content of your report into sections, then the section tag can be a good choice. - [<details> ](https://www.w3schools.com/tags/tag_details.asp)– Using a details element, you can easily create collapsible elements on your page. To change the animation of the element, you will need to use CSS. - [<dl> ](https://www.w3schools.com/tags/tag_dl.asp)– A 'description list' provides a natural way to display labelled data. For example, if you wish to elegantly display the name, age and birthplace of a person, then a description list can provide a simple solution. #### **Enabling JavaScript and CSS** Any script tags and inline JavaScript are stripped out by the HTML purifier by default (we currently use the HM HTML purifier). Databases can be given permission to use custom JavaScript by requesting the system administrator to add their database to the list within js\_in\_database\_authorised (example file available within the movetoparent directory). Style tags are also removed by the HTML purifier, but inline styling is retained. To keep style tags your database needs to be added to js\_in\_database\_authorised. Additional styling from the website’s home page is also added to the custom report, if allowed. J’ai créé un custom report avec du JS/Jquery (qui a été activé - base SF\_ScriptaManent\_Dev). Il comprend surtout des petites fonctions qui permettent par exemple de montrer/cacher des sections au clic sur un bouton Tout se passe bien quand j’affiche mes résultats en mode inline (voir capture) – le JS et le CSS sont bien pris en compte. Par contre, si je demande l’affichage sous forme de modale, le JS et le CSS ne sont plus du tout pris en compte. J'ai le même problème lorsque je clique sur un lien pour aller sur un autre fiche en relation, peu importe le mode d'affichage (sur une nouvelle page ou dans une modale). One of THE most powerful features of Heurist is the ability to modify record structures – not just the fields being J’ai essayé de placer mes fonctions JS au niveau du site et non du custom report, mais ça ne change rien et je ne vois pas comment résoudre ce problème. Le custom report est bien appliqué mais toute sa mise en forme n’est pas prise en compte et j'obtiens donc un affichage brut. En pièce jointe une section exemple avec le JS/CSS actifs en inline et la version non customisée sur tout autre mode de visualisation. \---------- Merci pour votre réponse. J'ai l'impression que c'est bien le JS + le CSS qui ne sont pas pris en compte, puisque ce sont des classes CSS qui me permettent d'avoir des résultats sur 2 colonnes. showReps.php - smarty report page runs without loading/initialization nearly all javascripts libraries. If you need to use jquery in your reports - define them explicitly in header of smarty template. I’ve added it <html> <head> <script src="https://code.jquery.com/jquery-1.12.2.min.js" integrity="sha256-lZFHibXzMHo3GGeehn1hudTAP3Sc0uKXBXAzHX1sjtk=" crossorigin="anonymous"></script> <script src="https://code.jquery.com/ui/1.12.1/jquery-ui.min.js" integrity="sha256-VazP97ZCwtekAsvgPBSUwPFKdrwD3unUfSGVYrahUqU=" crossorigin="anonymous"></script> <link rel="stylesheet" type="text/css" href="https://code.jquery.com/ui/1.12.1/themes/base/jquery-ui.css" /> <script> Merci beaucoup, ça marche. J'ai aussi dû ajouter le CSS dans le header pour qu'il soit pris en compte en dehors de la visualisation en inline. Du coup, ça a également répondu à une autre question que j'avais, qui était comment ajouter bootstrap au projet. #### **Where to place your CSS** We recommend placing your custom CSS at the top of the report wrapped within style tags. #### ***Embedding Custom CSS*** To embed CSS in your custom report, you can introduce <style> tags in the head of the report. These should ideally be enclosed in a {literal} command so that the SMARTY engine will not get confused (in fact, it only rarely gets confused, but you should make sure anyway). If you like, you can copy-and-paste the below code snippet into your report, immediately below the first <html> tag at the top of the template: <head> {literal} <style> /\* Place all custom styles here \*/ </style> {/literal} </head> You can also embed CSS in individual elements in your report. For example, the below code will center a paragraph and turn the text yellow: <p style="text-align: center; color: red;">This paragraph is now centered and coloured red.</p> This paragraph is now centered and coloured red. Since 'inline styling' can seem convenient, but in the long run it is better if you place all the styling infoormation in one place, and control it as an integrated whole. For a deeper introduction to CSS, please see our [CSS ](https://heuristref.net/h6-alpha/viewers/smarty/666)page. #### ***Embedding Custom JavaScript*** To embed JavaScript in a custom report, you can use a <script> tag. This can be a tricky task. Generally speaking, when you are getting started with JavaScript it is a good idea to place the <script> tag at the *end* of your report. The reason for this is that you don't want the user's browser to execute the JavaScript before all the other parts of the report have loaded. If you place the <script> tag at the \*start \*of your report, then the user's web browser may try to execute all the JavaScript before the rest of the report is ready. It might try to change the colour or size of a particular image or paragraph, but the image or paragraph has not been loaded yet. This will cause an error and probably prevent the JavaScript from working. If you wish to embed some JavaScript in your page, you can copy-and-paste the below code snippet, and place it at the end of your report, just above the final <html> tag: <script> {literal} // Place all JavaScript here {/literal} </script> For a fuller introduction to using JavaScript in a Heurist website, visit our [JavaScript](https://heuristref.net/h6-alpha/viewers/smarty/666) page. #### ***JQuery in reports*** showReps.php - smarty report page runs without loading/initialization nearly all javascripts libraries. If you need to use jquery in your reports - define them explicitly in header of smarty template. I’ve added it <html> <head> <script src="https://code.jquery.com/jquery-1.12.2.min.js" integrity="sha256-lZFHibXzMHo3GGeehn1hudTAP3Sc0uKXBXAzHX1sjtk=" crossorigin="anonymous"></script> <script src="https://code.jquery.com/ui/1.12.1/jquery-ui.min.js" integrity="sha256-VazP97ZCwtekAsvgPBSUwPFKdrwD3unUfSGVYrahUqU=" crossorigin="anonymous"></script> <link rel="stylesheet" type="text/css" href="https://code.jquery.com/ui/1.12.1/themes/base/jquery-ui.css" /> <script> #### **Adding Javascript** Heurist sanitises content to remove javascript which users might have inserted in html, for security reasons. If you need to use Javascript in your web pages, please ask you server manager to enable it by listing the name of the database in ..../HEURIST/js\_in\_database\_authorised.txt on the server. Example: // Sep 2019: This file lists databases on this server which may include JS code in the CMS Home Page or CMS Menu records // All other databases are excluded from executing such code. Order is unimportant. balipaintings johns\_hamburg ExpertNation etc. Note: To add Javascript to a web page you need to put it in the special Javascript field in Website Header / Layout Javascript embedded directly in the page will be filtered out even if it is authorised through the js\_in\_database\_authorised.txt file. #### **Where to put your JavaScript** We recommend placing your custom JavaScript at the top of the report wrapped within script tags. If the JavaScript is situational or requires a specific HTML element, e.g. a button or link, then place the JavaScript within script tags at the end of the report or after the specific HTML element. #### ### Server path and database name You can reference the server path and the database name in a smarty report as follows (in blue): <a href="{$heurist->constant("HEURIST\_BASE\_URL")}/heurist/hclient/framecontent/recordEdit.php ?db={$heurist->constant("HEURIST\_DB")}&recID={$r.recID}" target=\_blank>{$r.recTitle}</a> Op wo 18 sep. 2019 om 14:26 schreef Artem Osmakov <osmakov@gmail.com>: ### Record URL the recURL property seems to return nothing on anything I tried it on ({$r.recURL}, {$Relationship.recURL}, {$r.Relationship.recURL}) recURL is special header field. It becomes visible if mark "Show record URL on edit form:" in record type attribute window. In case you wish to specify url for specific record [https://heuristref.net/h6-alpha/?db=johns\_hamburg&fmt=html&recid={$r.recID}](https://heuristref.net/h6-alpha/?db=johns_hamburg&fmt=html&recid=132778) 1. whereas, in a for loop, {$Relationship.recTitle} works, {$Relationship.recRelationType} doesn't work (i.e., it does not seem to return anything). On the other hand, outside a for loop, {$r.Relationship.recRelationType} does work. In addition, I still do not know how to access the Person record from an Event in the Report editor. Persons are connected to Events through Actor entities. I can access the Actor through the "Relationship", but I do not know how I can access the Person linked to this Actor. In particular, I'd like to add the URL of the Person, not the Actor, to the report. No need in {$Relationship=$heurist->getRecord($Relationship)}. each entry in Relationships array is already a record. I've modified your report. Persons are linked to Actors. Thus need to use getLinkedRecords. This method has 3 parameters $rec - record id or record array - record to find records linked to or from this record $rtyt\_ID - record type or array of record type to filter output $direction - linkedfrom or linkedto or null to return both direcctions method returns array of record IDs devided to 2 arrays "linkedto" and "linkedfrom" <br/>Actors involved in this event: <ul> {foreach $r.Relationships as $Actor name=valueloop}{\* Relationship Events->Actors \*} <li>{$Actor.recID} {$Relationship.recTitle} (url:{$Actor.recURL}) (reltype:{$Actor.recRelationType}) {\* PV: How to make this refer to Person not Actor? \*} {$Persons = $heurist->getLinkedRecords($Actor, 10, 'linkedfrom')} {$Persons = $Persons.linkedfrom} {foreach $Persons as $Person\_ID name=valueloop2}{\* Link Actor->Person \*} {$Person=$heurist->getRecord($Person\_ID)} <br>Person: {$Person.recID} {$Person.recTitle} {/foreach}{\* Person \*} </li> {/foreach}{\* Actors \*} </ul> ### Images #### **Multiple images in a smarty report** $r.f8\_originalvalue - is array with full info about images (names, size, ids) $r.f8 - is just an url to an image. Or comma separated list of urls. Like: [https://heuristref.net/h6-alpha/?db=balipaintings&file=f0b08e2d6742e01315cc4adb1255dc8f712ea573](https://heuristref.net/h6-alpha/?db=balipaintings&file=f0b08e2d6742e01315cc4adb1255dc8f712ea573),[https://heuristref.net/h6-alpha/?db=balipaintings&file=a28c126e2d7b23844f8fd06e9df659a6789f8d34](https://heuristref.net/h6-alpha/?db=balipaintings&file=a28c126e2d7b23844f8fd06e9df659a6789f8d34) Thus, to access image urls you have either split $r.f8 to array {$images = explode(',',$r.f8)} {foreach from=($images) item=$s name=images} <div class="scrollimage"><img src="{$s}"/></div> {/foreach} Or access image ids from $r.f8\_originalvalue. {foreach from=($r.f8\_originalvalue) item=$s name=images} <div class="scrollimage"><img src="[https://heuristref.net/h6-alpha/?db=balipaintings&file={$s\['ulf\_ObfuscatedFileID'\]}](https://heuristref.net/h6-alpha/?db=balipaintings&file=%7B%24s%5B%27ulf_ObfuscatedFileID%27%5D%7D)"/></div> {/foreach} I believe the latter is reliable. See Bali Paintings: test\_art report. It has 3 options for file field {$r.f8}{\*Images (full Resolution)\*} <br> {wrap var=$r.f8\_originalvalue dt="file" width="300" height="auto"}{\*Images (full Resolution)\*} <br> {print\_r($r.f8\_originalvalue,true)} First one returns comma separated list of file urls. Second one generates 2 img tags for this field Third options provides you full access to file data. $r.f8\_originalvalue - is array that has all file properties Array ( \[0\] => Array ( \[ulf\_ID\] => 35448 \[fullPath\] => resources/haks/336a.jpg \[ulf\_ExternalFileReference\] => \[fxm\_MimeType\] => image/jpeg \[ulf\_Parameters\] => mediatype=image \[ulf\_OrigFileName\] => 336a.jpg \[ulf\_FileSizeKB\] => 1203 \[ulf\_ObfuscatedFileID\] => 04310a4cfd6883d63eda46e50021b36011f8912a \[ulf\_Description\] => \[ulf\_Added\] => 2015-03-13 16:05:48 ) \[1\] => Array ( \[ulf\_ID\] => 43315 \[fullPath\] => resources/earlyFiles/Haks336.jpg \[ulf\_ExternalFileReference\] => \[fxm\_MimeType\] => image/jpeg \[ulf\_Parameters\] => mediatype=image \[ulf\_OrigFileName\] => Haks336.jpg \[ulf\_FileSizeKB\] => 196 \[ulf\_ObfuscatedFileID\] => 36a8179bd143e2e26fd42e6ae13bf66f5fef4b77 \[ulf\_Description\] => \[ulf\_Added\] => 2016-11-08 21:13:08 ) ) #### **Mirador** Load mirador viewer into an iframe within a smarty report: {wrap var=$r.f38\_originalvalue dt="file" height="640" width="800"} Show thumbnail and open mirador viewer in popup (if heurist is detected) or in new tab: {wrap var=$r.f38\_originalvalue dt="file" height="auto" width="300" mode="thumbnail" fancybox="1"} Question: How does Herist know that an IIF Manifest is a manifest rather than just any old JSon file? (in fact it currently treats it as the latter in custom reports) We can register either info.json (reference to local or remote IIIF server that describes particular IIIF image) or manifest.json (that describes set of media and their appearance). On registration if mime type is application/json we loads this file and check whether it is image info or manifest. For former case we store in ulf\_OrigFileName “iiif\_image”, for latter one “iiif”. Dominique Stutzman: I confirm, the integration of a iiif manifest URL in a "File" type field works fine; sometimes you have to change the MIME type to application/json. Then a question: is it possible to import this particular type of "File(s)" in mass in the "Populate" menu? In the individually added data, which is used to generate the thumbnail and the call to the Mirador widget, we have the following metadata: <origName>\_iiif</origName> <mimeType>application/json</mimeType> <origName>\_remote</origName> <mimeType>application/json</mimeType> sometimes <mimeType>text/html</mimeType> #### **IIIF** *I've tested the method for displaying a viewer in a report and it works for an IIIF image. However, I couldn't get it to work for an IIIF manifest. I imagine there are some small changes to be made, could you tell me what they are? I need to display a manifest in the registry.tpl template.* Artem says, in blue: (please let me know if you have any problem, and which one you used in the end, as it will be useful documentation): There are 3 ways 1. Via wrap function (preferred) {wrap var=$r.f1200\_originalvalue dt="file" width="1200" height="800"}<br/> 2) Via direct manifest URL <iframe width=1200 height=800 src="https://heurist.huma-num.fr/h6-alpha/hclient/widgets/viewers/miradorViewer.php?db=pret19\_test&recID=&url={urldecode($r.f1200)}"></iframe> 3) Via file obfuscation ID {$r.f1200\_originalvalue\[0\].ulf\_ObfuscatedFileID} <iframe width=1200 height=800 src="[https://heurist.huma-num.fr/h6-alpha/hclient/widgets/viewers/miradorViewer.php?db=pret19\_test&iiif={$r.f1200\_originalvalue\[0\].ulf\_ObfuscatedFileID](https://heurist.huma-num.fr/h6-alpha/hclient/widgets/viewers/miradorViewer.php?db=pret19_test&iiif=%7B%24r.f1200_originalvalue%5B0%5D.ulf_ObfuscatedFileID)}"></iframe> #### **Embedding Mirador for IIIF images** - *t should work with this way* *{wrap var=$f1135.f1097\_originalvalue dt="file" width="1200" height="800"}* *However, since media is not registered as iiif manifest it shows it as a plain jpg image.* *So there is another way:* *{assign var='img\_id' value=$f1135.f1097\_originalvalue.0.ulf\_ObfuscatedFileID}* *<br>Obfuscation ID: {$img\_id}* *<iframe width=1200 height=800 src="*[*https://heurist.huma-num.fr/heurist/hclient/widgets/viewers/miradorViewer.php?db=pret19\_test&rec\_ID=&iiif\_image={$img\_id}*](https://protect-au.mimecast.com/s/Fh4VC3QNPBiXOJ893hgKVDH?domain=heurist.huma-num.fr)*"></iframe>* \----------------------- - ..miradorViewer.php?db=dbname&iiif\_image=d252a3fe145f0f9a5514a01688454ee36d20773d shows this media only. ..miradorViewer.php?db=dbname&q=ids:123 shows all media for record #### **Using OpenSeaDragon in a custom report/website** J'ai installé une petite visionneuse ([OpenSeadragon](https://url.au.m.mimecastprotect.com/s/jX6QC91WPRT2R7gE4SofPcq9DhL?domain=openseadragon.github.io/)) dans un *customreport sur* [*https://heurist.huma-num.fr/h6-alpha/?db=GrandFichier\_RB*](https://heurist.huma-num.fr/h6-alpha/?db=GrandFichier_RB), report name OSD, pour zoomer de façon immersive dans une image. Cette "image" est la numérisation d'une archive déposée dans la base Heurist que j'appelle depuis un record nommé "fiche". Exemple ici de ce que j'aimerais que ça donne : [https://codepen.io/Mathieu-Messager/pen/oggXOBV](https://url.au.m.mimecastprotect.com/s/owvmC0YKPvimJPDwNtDh2c9Emw5?domain=codepen.io) Voici mon bout de code sous le Smarty embarqué dans Heurist, corrected for multiple images by Maël Le Noc : <div class="offcanvas-body small"> <!-- VISIONNEUSE OpenSeaDragon--> <div id="openseadragon"></div> <script> var viewer = OpenSeadragon({ element: "openseadragon", prefixUrl: "[https://openseadragon.github.io/openseadragon/images/](https://url.au.m.mimecastprotect.com/s/bloCCgZ0N1iGPQxZEt2i4c4GYol?domain=openseadragon.github.io/)", tileSources: \[ {foreach $r.f1071\_originalvalue as $fid name=valueloop} { type: "image", url:" [https://heurist.huma-num.fr/heurist/?db=GrandFichier\_RB&file={$fid.ulf\_ObfuscatedFileID}](https://url.au.m.mimecastprotect.com/s/KBEkCE8wmrtp1GrmGh4I7c753GY?domain=heurist.huma-num.fr) " {\*numérisation de la fiche\*} }, {/foreach} \], collectionMode: true, sequenceMode: true, showNavigator: true, }); ``` \ \ ``` ### Displaying multiple files MF: In Custom Reports when a field of base type ‘file’ is repeatable, rather than returning an array, $heurist->getRecord returns a string. Moreover, it returns a list of heurist URLs even If the files are external links. In Vincent’s example below, all the images are hosted externally, but when you get the URL of the image in the Custom Report, you receive a Heurist URL with ?file=XXXXXX. Is this intentional? The behaviour when a file field is \*not \*repeatable is quite different – you receive the URL for the external file. \------ AO: If you add {print\_r($r, true)} to you smarty you will see the output. For file fields we have 2 entries fXXX - is just a string with comma separated urls and fXXX\_originalvalue contains array with ALL fields. If you prefer use external url {$r.f39\_originalvalue\[0\]\['ulf\_ExternalFileReference'\]} \[f39\] => [http://127.0.0.1/h6-ao/?db=osmak\_9b&file=884071c151ae247f9b6912f5e6b5b3df5853a770](https://protect-au.mimecast.com/s/uZyJC4QOPEiB10OG4cOg0mf?domain=127.0.0.1), [http://127.0.0.1/h6-ao/?db=osmak\_9b&file=31a7dca1c9e146f1e5c4213e89beba9ec9690926](https://protect-au.mimecast.com/s/abtsC5QPXJiZGj7OksO-Wg5?domain=127.0.0.1) \[f39\_originalvalue\] => Array ( \[0\] => Array ( \[ulf\_ID\] => 89 \[fullPath\] => file\_uploads/ulf\_89\_IMG-ed49a7c0b77925453b7b83640ceee026-V.jpg \[ulf\_ExternalFileReference\] => \[fxm\_MimeType\] => image/jpeg \[ulf\_Parameters\] => \[ulf\_OrigFileName\] => IMG-ed49a7c0b77925453b7b83640ceee026-V.jpg \[ulf\_FileSizeKB\] => 168 \[ulf\_ObfuscatedFileID\] => 884071c151ae247f9b6912f5e6b5b3df5853a770 \[ulf\_Description\] => \[ulf\_Added\] => 2022-02-11 15:46:02 \[ulf\_MimeExt\] => jpg ) \[1\] => Array ( \[ulf\_ID\] => 90 \[fullPath\] => file\_uploads/ulf\_90\_IMG-a3807536a83651e2bd50e88424858586-V.jpg \[ulf\_ExternalFileReference\] => \[fxm\_MimeType\] => image/jpeg \[ulf\_Parameters\] => \[ulf\_OrigFileName\] => IMG-a3807536a83651e2bd50e88424858586-V.jpg \[ulf\_FileSizeKB\] => 81 \[ulf\_ObfuscatedFileID\] => 31a7dca1c9e146f1e5c4213e89beba9ec9690926 \[ulf\_Description\] => \[ulf\_Added\] => 2022-02-11 15:46:14 \[ulf\_MimeExt\] => jpg ) ) Besides use wrap function to output image, video or audio player {wrap var=$r.f39\_originalvalue dt="file" width="300" height="auto"} Moreover, "wrap" function outputs ALL images. So, I've added {wrap var=$f1145.f1122\_originalvalue dt="file" width="600" height="auto" auto\_play="0" show\_artwork="0"} inside "liasse" loop [./viewers/smarty/showReps.php?db=leand\_khmerman&w=a&q=ids%3A2467&publish=1&debug=0&template=manuscript%20details.tpl](https://protect-au.mimecast.com/s/RsUgCZY1Nqi5N46pmHzVxmA?domain=heurist.huma-num.fr) If you wish to treat images just add another loop for array $f1145.f1122\_originalvalue ***Image carousel*** Note: JS must be enabled by your system adminstrator for your database (an entry in the permit javascript file in the HEURIST root directory) An image carousel can be added to a page in a website by placing suitable JS code in the custom JS field, as shown below. See also [https://www.w3schools.com/css/css\_image\_gallery.asp](https://www.w3schools.com/css/css_image_gallery.asp) for an alrernative CSS method.  //image gallery on home page var gallery = $('#image-gallery'); if(gallery.length>0){ var images = \[ {"title":"Arch of Titus, Rome (82 CE)", "img":"https://heurist.huma-num.fr/heurist/?db=judaism\_and\_rome&file=1c29ae0f2b3d245fb5d4ec47b9e286f9369ba03c"}, {"title":"Masada, King Herod's fortress and palace in the Judean desert (1st century BCE)", "img":"https://heurist.huma-num.fr/heurist/?db=judaism\_and\_rome&file=646583fae1f0cbafe699b78a5c62b28d4136329f"}, {"title":"Temple of Gaius Caesar and Lucius Caesar (Maison Carree), Nimes (16 BCE)", "img":"https://heurist.huma-num.fr/heurist/?db=judaism\_and\_rome&file=0bff598aa8716da5cada589c2dfcbf5372f9b239"}, {"title":"The Portonaccio Sarcophagus (190-195 CE)", "img":"https://heurist.huma-num.fr/heurist/?db=judaism\_and\_rome&file=30978cab2499206d66c132659e4c7a986ccd1eb5"} \]; window.hWin.HEURIST4.ui.initGalleryContainer(gallery, {content:images, maxWidth:1220, maxHeight:250, showTitle:true}); } ### Exporting geo.X and geo.Y How do I export geo.x and geo.y rather than a WKT for the locations X, Y {$r.f134.f28\_geojson\['coordinates'\]\[0\]}, {$r.f134.f28\_geojson\['coordinates'\]\[1\]} ### Video Video can be embedded by specifying the URL as a remote file in a File field *webpage:* **3D objects** *id 782* ### 3D objects Heurist now provides support for 3D objects (2 Dec 2022) using 3DHOP and ??? !\[\]\[image13\] **Preliminary documentation** Obj file should be converted to nxs and compressed to nxz with Nexus utilities. Then nxz can be uploaded and registered. Note: need to add nxz extension to the database usinf Admin > Manage Files and link at top right. This is not yet added to all databases. 3dhop viewer requires direct access to the 3d object file. Add the following .htaccess to the upload directory containing the file (normally file\_upload). order allow,deny <Files ~ "\\.(nxz|nxs|ply)$"> allow from all </Files> Further documentation to be provided soon - please bug us if not updated within a month (2 Dec 2022) #### **3D Viewer embedding** 1\) To redirect to 3d viewer need to specify parameter mode=page [https://heurist.huma-num.fr/h6-alpha/?db=MBH\_Manuscripta\_Bibliae\_Hebraicae&file=6435acd4e132673956e0962ab2dcafe0ed0ef429&mode=page](https://url.au.m.mimecastprotect.com/s/3cJmCzvkyVC83jlDzT4LOe_?domain=heurist.huma-num.fr) 2\) In Smarty the standard wrap function {wrap var=$r.f38\_originalvalue dt="file" height="640" width="800"} should generate <a href=" ./?db=MBH\_Manuscripta\_Bibliae\_Hebraicae&file=6435acd4e132673956e0962ab2dcafe0ed0ef429&mode=page " target="\_blank" rel="noreferrer noopener"><img src="/?db=MBH\_Manuscripta\_Bibliae\_Hebraicae&thumb=6435acd4e132673956e0962ab2dcafe0ed0ef429"></a> I've modified Template 3d-models-page.tpl for FBX: ``` version 1 :{wrap var=$r.f1128\_originalvalue dt="file"}\The Date field in the metadata of both map document and map layer will show on the timeline. You can choose to hide all dates from the timeline by unchecking the box, however this will also hide the results from your current query that also use a Date field.
First, create a map document, these are the mandatory fields: - name of map document - bounding box : using the tool on the left select a rectangle, that expresses the maximum extents of the two-dimensional object you want to map - map layers (see below) - map-zoom bookmarks: pre-defined zoom areas. The first bookmark will determine the initial map zoom. Specify as Name,Min Longitude,Max Longitude, Min Latitude, Max Latitude, Start date/time and End date/time (both optional). - zoom on point selection (km): the area to which to zoom when you select a point object (by default: 5km) Then, import one or more map layers by clicking \[Map layers\], these are the mandatory fields: - layer name - map layer data source: can be a KLM file or snipet, a map image file (non-tiled or tiled), a mappable query, a shapefile. Each of those will need another bounding box and a title. - type of data source: Google maps, Heurist query, raster or vector**🛟 Tip:** Use the symbology field and the style editor feature to create the presentation you like on each layer of your map. You can choose to show or hide each map document and each layer in the legend of the map.
### 1.2. The timeline The records are distributed on the timeline under the map. ① Any time field will be projected on the timeline. If several time fields are used on a record, they will all automatically show on the timeline. To hide a specific time field, uncheck the corresponding box on the left on the timeline under \[Current query\].**🛟 Tip:** Invalid dates will not be displayed on the timeline. Dates should be written according to ISO norm: yyyy, yyyy-mm, yyyy-mm-dd. Use minus (-) for BCE dates (eg. -375 for 375 BCE).
The timeline has various navigation features: - \[Zoom in\] and \[Zoom out\] ② - \[Zoom to all\] ③ - \[Zoom to selection\] ④ - \[Move to start\] and \[Move to end\] of the records ⑤ - \[Timeline options\] ⑥ : - choose the length of the labels: full length labels, truncate label to bar, fixed label width, or hide labels - choose the label's position: within the bar, or above the bar - choose the bar's position: stacked on the above the other, or wrapped to minimise height of timeline - filter map with current timeline range  ## 2. Network view ##### **🚀 How to start:** Explore → Search → Network ::: - To begin, click on \[Explore\] ① - Perform a search or use a \[Saved Filter\] that returns the records you want to include in your network ② - Click on \[Network\] ③  The **Network** view displays a records' network diagram. It provides an interactive visualisation of the current results set. Records are shown as nodes, and the connections (pointer fields and relationships) as the lines between nodes (edges).**🛟 Tip:** To get it working, two conditions must be met:
- records or records types should be linked - the current results set should gather all the records you want in your diagram **DON'T PANIC** if the diagram is not understandable immediately ! @todo: The diagram below has been replaced with a new and much more capable 'ego-network' diagram (from March 2026) which allows you to start with one or a small number of records, see all the connections from those records, and then expand the diagram outwards either by double-clicking records marked as having connections or from all the displayed records. This diagram will be further expanded with the ability to colour code or symbolise different characteristics of the nodes. Here's an example of a network diagram:  Each node displayed is a lab or a project. It shows how labs are interconnected through shared projects. Here you can see a record directly in the network viewer on the left. Some features are available on the header to make your diagram more accessible: - \[Node Control\]: - Select mode ① : select and drag simple node or select and drag multiple node by a selecting box (click-right and drag) - Gravity ② : determine to what degree entities are repositioned around the selected entity based on their relative weightings. Turn it on to choose the best presentation, and turn it off to lock down its position.  - \[Link Control\]: - Links ① : show or hide empty links and expand links - Node Size Formula ② : choose between linear or logarithmic formula - Fixed ③ : fix the size of the links  - \[Graph Control\]: - Refresh Data ① : go back to the original presentation of the nodes - Open or close Fullscreen ② - View Mode ③ : choose to show only the name of the record (big or small) or its name and its first field - Set Zoom ④ : zoom in or out of the diagram and set the view back to show the complete diagram - Export ⑤ : export the network data to a Gephi GEFX file  ## 3. Crosstabs ##### **🚀 How to start:** Explore → Search → Crosstabs - To begin, click on \[Explore\] ①. - Perform a search or use a \[Saved Filter\] that returns the records you want to include in your network. ② - Click on \[Crosstabs\] ③  The Crosstabs view provides a quantitative analysis of your data by calculating counts of aggregations sorted by category. A cross-tabulation is a way of calculating counts of aggregations sorted by category. Imagine value (set to Var 1) is the value of a colour system that has the entire spectrum of colours encoded as numbers. Numbers that are close to each other represent colours that are close to each other. Imagine that the type field (set to Var 2) indicates what material the potsherd is made out of. We can use a cross-tabulation to generate instant categories by splitting up the entire range of entered values into 10 buckets, or deciles. To run a simple cross-tabulation, search for the records you wish to analysis and select \[Crosstabs\]. The \[Crosstabs\] dialog displays. In the show fields for dropdown ①, select the record type you wish to analysis. Complete the variables: - ② Var 1 (rows) choose your first variable (this will simulate a tabulation by that variable). - ③ Var 2 (cols) choose the second variable (this splits the range of values into 10 'buckets' and counting how many values appear in each 'bucket' by type. - ④ Var 3 is an optional variable that breaks the analysis further, into 'pages'. Additionally, you can assign intervals by clicking on the pen ⑤.  ### 3.1. Focus on intervals It is possible to reassign intervals by merging, adding or deleting them. First, select the available values. By default, all values are selected. Then, add or remove intervals ② : - Click on \[Add Interval\] ④ to add an interval. - Click on left arrow to remove an interval, . - If you want remove all intervals, click on the blue arrow. - If you want to reset intervals, click on \[Reset\] ③.  It is also possible to merge values: 1. click on \[Add Interval\] ④ 2. select the values you wish to merge 3. click on the right arrow 4. rename the new interval  Some other functionalities are available: - Click on \[Save\] to save the current settings ① - Show the values count, the total of each row and or column, and their percentage ② - Counts aggregates values ③ - Display or hide null values and blank rows and columns ④  ### 3.2. Results You can see the results in table form or in a pie chart.🚨 Warning: you must select at least one variable to see some results.
The table's metadata is available ①. The table title can be customized ②. You can export the table in CSV or PDF format ③. You can search for a value in the table ④. The field or record type used as base for the crosstable is mentioned on its top ⑤.  You can also display your data as a pie chart.  # 8d: Summary : Mapping and visualisation Summary automatically generated on 11/25/2025 using the gpt-oss:120b model from the servers of [**Onyxia**](https://datalab.sspcloud.fr/) (INSEE) based on the complete document of the chapter. --- ### 1️⃣ Spatio‑temporal **Map** tab| Action | |
|---|---|
| **1** | Click **\[Explore\]** . |
| **2** | Run a search **or** use a **\[Saved Filter\]** to retrieve the records you want to map. |
| **3** | Select a **record** (any record that contains the required fields). |
| **4** | Click **\[Map\]** |
| Tool | Description |
|---|---|
| **Legend** | • **Result sets** – show/hide points belonging to the current result set. • **Map Documents** – (see *Publish* section). • **Base map** – choose background (e.g., *OpenStreetMap*). |
| **Zoom/Dezoom** | Standard zoom controls (🔍). |
| **\[full screen\]** | Expand the map to full‑screen mode. |
| **Help** | Opens the contextual help window. |
| **\[Bookmark\]** | Add a temporary point you can later retrieve. |
| **\[Search\]** | Geocode a place name (searches OSM index). |
| **\[Print\]** | Print the current map view. |
| **\[Publish map\]** | Generates an **iframe** snippet to embed the map on another page, optionally with controls (legend, bookmark, geocoder, selector, print). • You can also export the map as **KML** for Google Earth. |
| **Clusterisation** | Points are automatically clustered; clusters recompute on zoom/dezoom. |
| Setting | What it does |
|---|---|
| **Include** – *current query* | The iframe displays the map built from the query you just ran. |
| **Include** – *opened map documents* | (still under documentation – shows any additional map layers you have opened). |
| **Controls** | Choose which UI elements appear inside the iframe (legend, bookmark, geocoder, selector, print). |
| **Visible in legends** | Choose which legend items are shown (basemap, result set, map documents). |
| **Other settings** | *Use current basemap*, *Allow modify symbology*, *Show map*, *Show timeline*, *Marker clusters* . |
| **Popup template** | You can pick a custom HTML template for the pop‑ups (create a new template in the **Templates** section of Heurist). |
| **Copy code** | Two formats are offered: **embed** (standard ` |