Page Comparison

The Data Loader uses config files for facet creation, which has an HJson format (which is a more human friendly superset of Json). In the following chapters you can find the description of the attributes used in these files and some examples.

...

Facets config file

Sample file

Below is an example of a fully valid Hjson file which is not a valid Json. Notice how some of the keys/values are missing quotes and some rows are missing commas a the the end. 

{ 
	"InteractionSubject": {
		"name": "Interaction Subjectinteraction_subject",
		"display_name": "Interaction Subject",
		"group_name": "Interactions",
		"visible": true,
		"searchable":true,
        "typeahead":true
	},
	"InteractionType": {
		"name": "Type of Interaction interaction_type",
		"display_name": "Interaction Type",
		"group_name": "Interactions",
		"visible": true,
		"searchable":true,
        "typeahead":false
	},
	"Date": {
		"
        "name": "creation_date",
        "display_name": "Date of creationCreation",
		"data_type": "datetime",
		"input_format_string": "%Y-%m-%dT%H:%M:%S",
		"default_value":"1900/01/01",
		"visible": true
	},
	"EntittledUsersEntitledUsers": {
        "name": "users",
        "display_name": "Users",
        "auth": true,
        "auth_value_mandatory": true,
        "import": false
    },
    "InternalAttendees": {
        "name": "attendees",
        "display_name": "Attendees",
        "group_name": "Interactions",
        "pivotal_group": "Members",
        "delimiter": ";",
        "visible": true
    },
	"NoAtendees": {
		name        "name": "number_of_attendees",
        "display_name": "Number of AtendeesAttendees",
		"data_type": "int",
		"visible": true,
		"searchable":false
	},
}

Best Practices of Facet Naming

Follow the best practices for facet names and have a user friendly, nice looking name in the "display_name" but mind the maximum length mentioned below.

Best practices for the facet names:

• Only use lower case
• Use an underscore as a separator to join multiple words
• Avoid using space as a separator
• Avoid having any special characters in the facet name

Structure: Facet Keys and Facet Attributes

In the examples above, the curly brackets at the root of the file open a new dictionary. Within each dictionary there are a number of facet keys which, in turn have their own dictionary of key / value pairs - the facet attributes.

Image RemovedImage Added

• Facet Keys are used to identify data elements in the data source the facets are being applied to, for example the column headings in an Excel spreadsheet.
• Facet Attributes are used to define the behaviour of the facet and how it shold be handled by Squirro. See the reference below for more details.

...

Facet Attributes Reference

...