Skip to main content
Kinetic Community

Resource Definition

The resource configuration file is responsible for defining where the resource information comes from.

Description

A resource can be anything from a person, a location, a piece of hardware, a room, a projector, etc...  This file also defines the field mappings used to identity the resource key and label, and to identify the qualification used to retrieve the appropriate data from the resource system.

Resource records are displayed in a vertical column along the left hand side of the schedule view window.  Each resource record has its own row that will be used to display the data source records associated to the resource.  The data source records must be linked to the resource records by the field identified in the sourceMapKey property.

Properties

All the following properties must be included in the configuration file, even if they are not used.  Properties that are not used should be set to the blank string "".

 

Property Description
uuid

A unique identifier comprised of an alpha-numeric string.

Example: "sites"

name

The name or label that end users will see that describe the resources.

Example: "Sites"

connectionName

The name of the connection that is used to retrieve resources.  This must match the "name" property of one of the connection configuration files.

Example: "ars-server"

showAllResources

If true, all resources will be drawn even if there are no data events associated with the source.  If false, only resources that contain data events will be displayed.

Example: "true"

source

The name of the structure (database table, file, etc...) on the end point system that contains the resource data.  

Adapter Specific - This value depends on the type of adapter used to retrieve the data.

 

Example: "CompanySites"

sourceMapKey

The name of the field or location on the end point system that contains the resource's unique identifier, or key.  The end user will not see this value, but it is used to link data events to the resource.

Adapter Specific - This value depends on the type of adapter used to retrieve the data.

 

Example: "179"

sourceMapValue

The name of the field or location on the end point system that contains the resource's name or label.  This value will be displayed to the end user as the resource name.

Adapter Specific - This value depends on the type of adapter used to retrieve the data.

 

Example: "700000001"

sourceMapCriteria

The qualification or query string used to retrieve the list of resources from the end point system.

Adapter Specific - This value depends on the type of adapter used to retrieve the data.

 

  • The quotation (") and backslash (\) characters may be used in the criteria string, but they must be escaped by prefixing the character with a backslash (\) character.
  • The entire criteria, or portions of the criteria may be passed as URL parameters. This allows the criteria to become dynamic. Dynamic portions of the criteria are denoted by the use of special delimiter characters enclosing the dynamic parameter name:
    {{parameterName}}
    Anything in between the delimiters is expected to be passed on the URL using the parameter name defined between the delimiters.
    • For Example, suppose a ticket id was to be passed when the user clicks on a link or button in an external system.  The Kinetic Schedule URL could be built up by appending a parameter with the value of the ticket id.
    • So if the the sourceMapCriteria was:
      "'Ticket Id'=\"{{ticketId}}"
      the following information would be appended to the URL: &ticketId=555.
    • The resultant criteria would then be
      'Ticket Id'="555".
 

Example: ""

filterFields

A structured list of fields or locations (and possible values) from the resource end system that may be used to filter the list of resources that are displayed to the end user.

Please see the filter fields configuration page for more details.

clickHandler

NEW in v1.1.0

If defined, allows an action to take place when a user clicks on a resource.  This could be used to display more information about the resource.

Please see the click handlers configuration page for more details.

createdAt

Not used, may set to null.  If used, must be an ISO8601 formatted date string.

 

Formatyyyy-MM-ddTHH:mm:ssZ

Example: "2013-07-17T16:33:06-0500"

createdBy

Not used.

May set to blank string - ""

modifiedAt

Not used, may set to null.  If used, must be an ISO8601 formatted date string.

 

Formatyyyy-MM-ddTHH:mm:ssZ

Example: "2013-07-17T16:33:06-0500"

modifiedBy

Not used.

May set to blank string - ""

 

Sample Resource Configuration File

A sample resource configuration file that utilizes a BMC Remedy ARS connection.  Notice the sourceMapKey, sourceMapValue, and filter fieldIds all reference Remedy field ids.  These values would most likely have a different meaning or format if a different adapter was used.

 

{
    "resource": {
        "uuid": "sites",
        "name": "Sites",
        "connectionName": "ars-server",
        "showAllResources": "true",
        "source": "CompanySites",
        "sourceMapKey": "179",
        "sourceMapValue": "700000001",
        "sourceMapCriteria": "'Status'=\"Active\"",
        "clickHandler": {},
        "filterFields": [
            {
                "fieldId": "700000003",
                "name": "Country",
                "values": [
                    {
                        "value": "USA",
                        "color": "#0000cc"
                    },
                    {
                        "value": "Canada",
                        "color": "#cc0000"
                    }
                ]
            }
        ],
        "createdAt": null,
        "createdBy": "",
        "modifiedAt": null,
        "modifiedBy": ""
    }
}