Documented mapping.json file Example - Fluid Topics - 3.2

Manage Map Attachments in Fluid Topics

Product
Fluid Topics
FT_Version
3.2
Category
Technical Notes
language
English
audience
public

The following lines show a documented example of a mapping.json file used to associate an attachment to your publication.

[
{
"map": "hashed URI of map 1",
"helper": {
"title": "Title of map 1",
"metas": [
{
"key": "metadata used to create the facet",
"label": "name of facet 1 applied to the map",
"values": [
"value of facet 1 applied to the map"
]
},
{
"key": "metadata used to create facet 2",
"label": "name of facet 2 applied to the map",
"values": [
"value of facet 2 applied to the map"
]
}
]
},
"files": [
{
"name": "name of the attached document to be displayed with map 1",
"file": "COMPLETE path of the file in the archive to be uploaded",
"description": "description of the attached file NOT DISPLAYED on the portal"
}
]
},
{
"map": "hashed URI of map 2",
"helper": {
"title": "Title of map 2",
"metas": [
{
"key": "metadata used to create facet 1",
"label": "name of facet 1 applied to the map",
"values": [
"value of facet 1 applied to the map"
]
},
{
"key": "metadata used to create facet 2",
"label": "name of facet 2 applied to the map",
"values": [
"value of facet 2 applied to the map"
]
}
]
},
"files": [
{
"name": "name of the attached document to be displayed with map 2",
"file": "COMPLETE path of the file in the archive to be uploaded",
"description": "description of the attached file NOT DISPLAYED on the portal"
}
]
}
]

The following table describes the parameters of the mapping.json file:

Elements

Card.

Description

map

Mandatory

The URI in the Knowledge Hub of a publication Map.

It is unique and can be retrieved from the URL of the map when it is opened in the Reader page: https://mysite.fluidtopics.net/reader/$MAP_URI

helper

Optional

This section has two fields title and versions. It is meant to help you understand what document and version you are referring to in the map field. It is not used by Fluid Topics.

helper.title

Optional

Displays the name of the map as it appears on the portal.

helper.metas

Optional

Displays the list of metadata applied to the map.

files

Mandatory

The list of files that have to be attached to the publication.

files.name

Optional

The name of the file to be displayed in the portal. If not provided, the file name will be used.

files.file

Mandatory

The relative path in the archive of the file (file name and extension included) to attach to the publication.

Note: It is also possible to enter a web URL to declare the file to be associated with the publication.

This parameter is only mandatory if there is an attached file.

files.description

Optional

A short description for the file that can be consulted on the mapping.json file.