File Structure

Below is a sample event type configuration file. As with all configuration files, it uses the JSON format to define the event type properties.

{
    "name": "Completed Changes",
    "status": "Active",
    "defaultFilter": "",
    "detailsPage": "/themes/default/event.jsp",
    "clickHandler": {},
    "color": "grey",
    "source": {
        "connectionName": "ITSM ARS",
        "configuration": {
            "Form": "CHG:Infrastructure Change",
            "Qualification": "'1000002195'!=$\\NULL$"
        },
        "coreMappings": {
            "Id": "{{1000000182}}",
            "Name": "{{1000000182}}",
            "Description": "{{1000000000}}",
            "Start": "{{1000000348}}",
            "End": "{{1000000364}}"
        },
        "detailMappings": {
            "Manager Group": "{{1000000015}}",
            "Change Manager": "{{1000000403}}",
            "Change Location": "{{303935100}}",
            "Change Reason": "{{1000000294}}",
            "Service": "{{303497300}}",
            "Class": "{{1000000568}}",
            "Priority": "{{1000000164}}",
            "Urgency": "{{1000000162}}",
            "Impact": "{{1000000163}}",
            "Risk Level": "{{1000000180}}",
            "Status": "{{303502600}}",
            "Status Reason": "{{1000000881}}"
        },
        "filterMappings": [
            {
                "name": "Manager Group",
                "value": "{{1000000015}}",
                "values": {}
            },
            {
                "name": "Change Manager",
                "value": "{{1000000403}}",
                "values": {}
            },
            {
                "name": "Priority",
                "value": "{{1000000164}}",
                "values": {
                    "Critical": "red",
                    "High": "chocolate",
                    "Medium": "cornflowerblue",
                    "Low": "#333333"
                }
            },
            {
                "name": "Urgency",
                "value": "{{1000000162}}",
                "values": {}
            },
            {
                "name": "Impact",
                "value": "{{1000000163}}",
                "values": {}
            }
        ]
    }
}

Like the calendar configuration, Kinetic Calendar only expects one group of event type properties in this file. So the file is wrapped with opening and closing braces instead of brackets like the connections configuration file.

Since the JSON format was discussed in more detail on the connection configuration page and calendar configuration page, this page will focus on the event type properties and how the data source mappings work.

Event Type Properties

Not all of the properties defined in the listing above are required. Some properties can assume a default value if not provided. This is a listing of all the event type properties, indicating which ones are required, and what the default values are for those that are not required.

Mappings

The mapping properties (coreMappings, detailMappings, and filterMappings) are used to map values from the data source to a Kinetic Calendar event. The syntax used for the mappings will be dependent on the adapter used in the event type connection.

Core Mappings

A Kinetic Calendar event contains six core properties that are used internally by the calendar application to determine how the event is displayed in the calendar view. The core event properties are the following:

📘

Required Core Mappings

Four of the core mapping properties must be mapped to a piece of data from the data source so the event can properly be identified and rendered in the calendar.

ID - used to uniquely identify the event to retrieve additional information.

Name - displayed on the calendar so users can quickly and easily identify what the event does or relates to based on the type of events the user is viewing.

Description - provides more information than just the event name provides (like a summary). The value of the property is also displayed as hover text when the user hovers the mouse over the event.

Start Date/Time - required so Kinetic Calendar can determine where to the event in relation to the calendar days or time slots available in the current view.

"Manager Group": "{{1000000015}}"

In this example, the name of the detail mapping is "Manager Group". The value of the detail mapping references a field on the data source - in this case it is field 1000000015 on the Remedy ARS Form "CHG:Infrastructure Change". This tells Kinetic Calendar to retrieve the record from the "CHG:Infrastructure Change" form that matches the event ID, and return the value of field 1000000015 identified as "Manager Group".

When the user clicks on this event to retrieve additional details, the user will see the following information:

Filter Mappings

In this example, the name of the detail mapping is "Manager Group". The value of the detail mapping references a field on the data source - in this case it is field 1000000015 on the Remedy ARS Form "CHG:Infrastructure Change". This tells Kinetic Calendar to retrieve the record from the "CHG:Infrastructure Change" form that matches the event ID, and return the value of field 1000000015 identified as "Manager Group".

When the user clicks on this event to retrieve additional details, the user will see the following information:

"filterMappings": [
    {
        "name": "Manager Group",
        "value": "{{1000000015}}",
        "values": {}
    },
    {
        "name": "Change Manager",
        "value": "{{1000000403}}",
        "values": {}
    },
    {
        "name": "Priority",
        "value": "{{1000000164}}",
        "values": {
            "Critical": "red",
            "High": "chocolate",
            "Medium": "cornflowerblue",
            "Low": "#333333"
        }
    },
    {
        "name": "Urgency",
        "value": "{{1000000162}}",
        "values": {}
    },
    {
        "name": "Impact",
        "value": "{{1000000163}}",
        "values": {}
    }
]

This code is building up a list of 5 filter fields, each with a name or label, the field or property on the data source where the value is retrieved, and a list of possible values that will be defined with a predetermined color.

The name is simply a text label that represents the criteria of what the field value relates to.

The format of the value property will be dependent on the adapter used in the event type connection. In this example, the value references a field on the data source - in this case it is a field on a Remedy ARS Form. This tells Kinetic Calendar to retrieve the record from the form that matches the event ID, and return the value of this field identified as the label used in the name property.

The values property is a list of name/value pairs that represent possible values for the field, with the color that events with this field value should be displayed as. The color will only be used when the events are being filtered on this filter mapping.

Take a look at the filter mapping identified with the name "Priority" in the listing above. This filter mapping defines four values that will display events with specified colors. When the event type is filtered on the Priority filter mapping, all events that have a priority value of "Critical" will be displayed in red. All "High" priority events will be displayed in chocolate, all "Medium" priority events will be displayed in cornflowerblue, and all "Low" priority events will be displayed in #333333, which is a shade of grey resembling black. Events that have any other priority value will be assigned a color by the system since it wasn't defined in the event type configuration.

Supported colors for filtered event values are the same as supported colors for event types. Color values may be any of the html hex colors in the range #000000 - #FFFFFF, or any of the standard css color names: http://www.w3schools.com/cssref/css_colornames.asp