Versions Compared

Old Version 13

changes.mady.by.user andrew johnston

Saved on

compared with

New Version 14

changes.mady.by.user andrew johnston

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This toolkit element allows you to use regex or javascript to set the document metadata fields (eg title, description, publishedDate).

Table of Contents

Format

TODO convert to JSON

Code Block
{
	"display": string,
	"docMetadata": {
		"title":string,// The string expression or $SCRIPT(...) specifying the document title
		"description":string,// The string expression or $SCRIPT(...) specifying the document description
		"publishedDate":string,// The string expression or $SCRIPT(...) specifying the document publishedDate
		"fullText":string,// The string expression or $SCRIPT(...) specifying the document fullText
		"displayUrl":string,//The string expression or $SCRIPT(...) specifying the document displayUrl
		"appendTagsToDocs":Boolean,// if true (*NOT* default) source tags are appended to the document 
		"geotag" {config_param_name"}//Specify a document level geo-tag
	}

...

ParameterDescription
title

The string expression or $SCRIPT(...)

descriptionIbid.
publishedDateIbid.
fullTextIbid.
displayUrl

"displayUrl" sets the corresponding document JSON field. It is guaranteed not to be used by the Infinit.e platform. It is therefore useful for linking documents to external content. For reference, the way that it is used in the Infinit.e GUI is as follows:

  • If it starts with "http://" then it is treated as a web link
  • Otherwise, it is assumed to be a relative file path to the fileshare specified in the source url field. (eg you can use the "Document  - File - Get" call with the "sourceKey" concatenated to the "displayUrl" to retrieve the file directly from the fileshare).
appendTagsToDocs

If true (*NOT* default) source tags are appended to the document.

geoTag

using geo tag the following is possible

  • specify the fields to extract from your structured data source to use as your latitude and longitude values
  • specify city, state/province, and country.

See example below.

...

Examples

Setting Metadata Values

When document metadata is extracted from a source (via the File, Database, or other technique), each field extracted is captured in the Feed.metadata object. Using document metadata, data stored in the Metadata object can be access using the $ operator to signify that we are attempting to retrieve data from a field in our document.

...