Skip to main content
Kinetic Community

Configuration Files

Configuration Directory

The configuration directory is the file sytem location on the web server where the schedule configuration files exist.  The web server must have read access to this directory so it can load up the configured adapters, connections, and calendars.  And the web server must have write access to the logs directory held within this configuration directory.

The location for this directory is configured in the web application properties file.  It is recommended to create a directory on the web server outside of the deployed web application, and store the configuration files there.

A sample configuration is shipped with the installation file, and is deployed with the application.  The sample configuration directory can be found at <deployed_web_application>/sample_config.

 

Configuration File Format

All configuration files for Kinetic Schedule use the JSON format, and so all files end in .json to denote that.  The JSON file format stands for JavaScript Object Notation, and more information about the file format can be found at http://json.org/.

 

The convention used to format configuraiton properties of each component is as follows:

{
    "componentType": {
        "stringProperty1Name": "stringProperty1Value",
        "stringProperty2Name": "stringProperty2Value",
        "objectProperty1Name": {
            "subProp1Name": "subProp1Value",
            "subProp2Name": "subProp2Value"
        },
        "arrayProperty1Name": ["arrValue1", "arrValue2", "arrValue3"],
        "lastPropertyName": "lastPropertyValue"
    }
}

 

Configuration File Hierarchy

The configuration files must be laid out in the proper hierarchy for the Kinetic Schedule web application to find them.  Below is a screenshot depicting a properly formed configuration directory with all required directories.

file-hierarchy.png

 

From the image above, the configuration directory is located at C:\kinetic-schedule.  Within this directory is an adapters directory that contains an adapters.json file to defines the available adapters, a calendars directory that contains a subdirectory for each calendar, a connections directory that contains the connections.json file to define configured instances of adapters, and a logs directory where the application will write log files.

The requirements of a properly structured configuration directory are the following:

  • The existence of an adapters directory that contains the adapters.json file.  The format of this file is discussed on the Adapters Configuration page.
  • The existence of a connections directory that contains a configuration file for each connection that will be used.  The format and naming convention of the connection configuration file is discussed on the Connections Configuation page.
  • The existence of a calendars directory.
  • The existence of a logs directory.

 

Calendars Directory Structure

The individual calendar directories can be named anything, as long as they are valid file names.  Each calendar directory must be properly formed as well.  Below is a screenshot depicting a properly formed calendar directory, with a calendar configuration file, a resource configuration file, and a data source configuration file.

file-hierarchy-calendar.png

 

The calendar directory is located at C:\kinetic-schedule\calendars\test_en.  This directory is within the configuration data directory at C:\kinetic-schedule.  Within this directory is a calendar configuration file, denoted with the prefix "cal_", a resource configuration file denoted with the prefix "res_", and a data source configuration file denoted with the prefix "ds_" and a unique decimal as the suffix.  Notice all file names contain the name of the calendar directory after the prefix.

 

The requirements of a properly structured calendar directory are the following:

  • The existence of a calendar configuration file named "cal_<calendar_directory_name>.json".  The format of the calendar configuration file is discussed on the Calendar Configuration page.
  • The existence of a resource configuration file named "res_<calendar_directory_name>.json".  The format of the resource configuration file is discussed on the Resource Configuration page.
  • The existence of at least one data source configuration file that begins with "ds_<calendar_directory_name>" and ends with "<unique_integer>.json".  The format of the data source configuration file is discussed on the Data Source Configuration page.
  • Any number of data sources can be configured per calendar as long as they all follow the proper naming conventions.

 

Calendar File Naming Conventions

  • Calendar configuration file:    cal_<unique_calendar_guid>.json
  • Resource configuration file:    res_<unique_calendar_guid>.json
  • Data Source configuration file:    ds_<unique_calendar_guid>_<integer>.json

 

  * NOTE: each data source file name must contain an index number following the calendar guid.